Client
cloudhsmv2 | R Documentation |
AWS CloudHSM V2¶
Description¶
For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- cloudhsmv2(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- copy_backup_to_region
- Copy an CloudHSM cluster backup to a different region
- create_cluster
- Creates a new CloudHSM cluster
- create_hsm
- Creates a new hardware security module (HSM) in the specified CloudHSM cluster
- delete_backup
- Deletes a specified CloudHSM backup
- delete_cluster
- Deletes the specified CloudHSM cluster
- delete_hsm
- Deletes the specified HSM
- delete_resource_policy
- Deletes an CloudHSM resource policy
- describe_backups
- Gets information about backups of CloudHSM clusters
- describe_clusters
- Gets information about CloudHSM clusters
- get_resource_policy
- Retrieves the resource policy document attached to a given resource
- initialize_cluster
- Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate
- list_tags
- Gets a list of tags for the specified CloudHSM cluster
- modify_backup_attributes
- Modifies attributes for CloudHSM backup
- modify_cluster
- Modifies CloudHSM cluster
- put_resource_policy
- Creates or updates an CloudHSM resource policy
- restore_backup
- Restores a specified CloudHSM backup that is in the PENDING_DELETION state
- tag_resource
- Adds or overwrites one or more tags for the specified CloudHSM cluster
- untag_resource
- Removes the specified tag or tags from the specified CloudHSM cluster