paws.security.identity (version 0.7.0)

cloudhsm: Amazon CloudHSM

Description

AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Usage

cloudhsm(config = list(), credentials = list(), endpoint = NULL, region = NULL)

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.

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.

Service syntax

svc <- cloudhsm(
  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

add_tags_to_resource	This is documentation for AWS CloudHSM Classic
create_hapg	This is documentation for AWS CloudHSM Classic
create_hsm	This is documentation for AWS CloudHSM Classic
create_luna_client	This is documentation for AWS CloudHSM Classic
delete_hapg	This is documentation for AWS CloudHSM Classic
delete_hsm	This is documentation for AWS CloudHSM Classic
delete_luna_client	This is documentation for AWS CloudHSM Classic
describe_hapg	This is documentation for AWS CloudHSM Classic
describe_hsm	This is documentation for AWS CloudHSM Classic
describe_luna_client	This is documentation for AWS CloudHSM Classic
get_config	This is documentation for AWS CloudHSM Classic
list_available_zones	This is documentation for AWS CloudHSM Classic
list_hapgs	This is documentation for AWS CloudHSM Classic
list_hsms	This is documentation for AWS CloudHSM Classic
list_luna_clients	This is documentation for AWS CloudHSM Classic
list_tags_for_resource	This is documentation for AWS CloudHSM Classic
modify_hapg	This is documentation for AWS CloudHSM Classic
modify_hsm	This is documentation for AWS CloudHSM Classic
modify_luna_client	This is documentation for AWS CloudHSM Classic
remove_tags_from_resource	This is documentation for AWS CloudHSM Classic

Examples

if (FALSE) {
svc <- cloudhsm()
svc$add_tags_to_resource(
  Foo = 123
)
}