Class: Aws::CloudHSMV2::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/aws-sdk-cloudhsmv2/client.rb

Overview

An API client for CloudHSMV2. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::CloudHSMV2::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When ‘:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CloudHSMV2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudHSMV2::EndpointParameters`

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



395
396
397
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 395

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1267
1268
1269
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1267

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1270
1271
1272
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1270

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1245

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-cloudhsmv2'
  context[:gem_version] = '1.54.0'
  Seahorse::Client::Request.new(handlers, context)
end

#copy_backup_to_region(params = {}) ⇒ Types::CopyBackupToRegionResponse

Copy an AWS CloudHSM cluster backup to a different region.

Examples:

Request syntax with placeholder values


resp = client.copy_backup_to_region({
  destination_region: "Region", # required
  backup_id: "BackupId", # required
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.destination_backup.create_timestamp #=> Time
resp.destination_backup.source_region #=> String
resp.destination_backup.source_backup #=> String
resp.destination_backup.source_cluster #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_region (required, String) —

    The AWS region that will contain your copied CloudHSM cluster backup.

  • :backup_id (required, String) —

    The ID of the backup that will be copied to the destination region.

  • :tag_list (Array<Types::Tag>) —

    Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

Returns:

See Also:



443
444
445
446
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 443

def copy_backup_to_region(params = {}, options = {})
  req = build_request(:copy_backup_to_region, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Creates a new AWS CloudHSM cluster.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  backup_retention_policy: {
    type: "DAYS", # accepts DAYS
    value: "BackupRetentionValue",
  },
  hsm_type: "HsmType", # required
  source_backup_id: "BackupId",
  subnet_ids: ["SubnetId"], # required
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.cluster.backup_policy #=> String, one of "DEFAULT"
resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
resp.cluster.backup_retention_policy.value #=> String
resp.cluster.cluster_id #=> String
resp.cluster.create_timestamp #=> Time
resp.cluster.hsms #=> Array
resp.cluster.hsms[0].availability_zone #=> String
resp.cluster.hsms[0].cluster_id #=> String
resp.cluster.hsms[0].subnet_id #=> String
resp.cluster.hsms[0].eni_id #=> String
resp.cluster.hsms[0].eni_ip #=> String
resp.cluster.hsms[0].hsm_id #=> String
resp.cluster.hsms[0].state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
resp.cluster.hsms[0].state_message #=> String
resp.cluster.hsm_type #=> String
resp.cluster.pre_co_password #=> String
resp.cluster.security_group #=> String
resp.cluster.source_backup_id #=> String
resp.cluster.state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
resp.cluster.state_message #=> String
resp.cluster.subnet_mapping #=> Hash
resp.cluster.subnet_mapping["ExternalAz"] #=> String
resp.cluster.vpc_id #=> String
resp.cluster.certificates.cluster_csr #=> String
resp.cluster.certificates.hsm_certificate #=> String
resp.cluster.certificates.aws_hardware_certificate #=> String
resp.cluster.certificates.manufacturer_hardware_certificate #=> String
resp.cluster.certificates.cluster_certificate #=> String
resp.cluster.tag_list #=> Array
resp.cluster.tag_list[0].key #=> String
resp.cluster.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_retention_policy (Types::BackupRetentionPolicy) —

    A policy that defines how the service retains backups.

  • :hsm_type (required, String) —

    The type of HSM to use in the cluster. Currently the only allowed value is ‘hsm1.medium`.

  • :source_backup_id (String) —

    The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

  • :subnet_ids (required, Array<String>) —

    The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

    • All subnets must be in the same virtual private cloud (VPC).

    • You can specify only one subnet per Availability Zone.

  • :tag_list (Array<Types::Tag>) —

    Tags to apply to the CloudHSM cluster during creation.

Returns:

See Also:



534
535
536
537
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 534

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_hsm(params = {}) ⇒ Types::CreateHsmResponse

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Examples:

Request syntax with placeholder values


resp = client.create_hsm({
  cluster_id: "ClusterId", # required
  availability_zone: "ExternalAz", # required
  ip_address: "IpAddress",
})

Response structure


resp.hsm.availability_zone #=> String
resp.hsm.cluster_id #=> String
resp.hsm.subnet_id #=> String
resp.hsm.eni_id #=> String
resp.hsm.eni_ip #=> String
resp.hsm.hsm_id #=> String
resp.hsm.state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
resp.hsm.state_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String) —

    The identifier (ID) of the HSM’s cluster. To find the cluster ID, use DescribeClusters.

  • :availability_zone (required, String) —

    The Availability Zone where you are creating the HSM. To find the cluster’s Availability Zones, use DescribeClusters.

  • :ip_address (String) —

    The HSM’s IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don’t specify an IP address, one is chosen for you from that subnet.

Returns:

See Also:



583
584
585
586
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 583

def create_hsm(params = {}, options = {})
  req = build_request(:create_hsm, params)
  req.send_request(options)
end

#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Examples:

Request syntax with placeholder values


resp = client.delete_backup({
  backup_id: "BackupId", # required
})

Response structure


resp.backup.backup_id #=> String
resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
resp.backup.cluster_id #=> String
resp.backup.create_timestamp #=> Time
resp.backup.copy_timestamp #=> Time
resp.backup.never_expires #=> Boolean
resp.backup.source_region #=> String
resp.backup.source_backup #=> String
resp.backup.source_cluster #=> String
resp.backup.delete_timestamp #=> Time
resp.backup.tag_list #=> Array
resp.backup.tag_list[0].key #=> String
resp.backup.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_id (required, String) —

    The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

Returns:

See Also:



626
627
628
629
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 626

def delete_backup(params = {}, options = {})
  req = build_request(:delete_backup, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster_id: "ClusterId", # required
})

Response structure


resp.cluster.backup_policy #=> String, one of "DEFAULT"
resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
resp.cluster.backup_retention_policy.value #=> String
resp.cluster.cluster_id #=> String
resp.cluster.create_timestamp #=> Time
resp.cluster.hsms #=> Array
resp.cluster.hsms[0].availability_zone #=> String
resp.cluster.hsms[0].cluster_id #=> String
resp.cluster.hsms[0].subnet_id #=> String
resp.cluster.hsms[0].eni_id #=> String
resp.cluster.hsms[0].eni_ip #=> String
resp.cluster.hsms[0].hsm_id #=> String
resp.cluster.hsms[0].state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
resp.cluster.hsms[0].state_message #=> String
resp.cluster.hsm_type #=> String
resp.cluster.pre_co_password #=> String
resp.cluster.security_group #=> String
resp.cluster.source_backup_id #=> String
resp.cluster.state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
resp.cluster.state_message #=> String
resp.cluster.subnet_mapping #=> Hash
resp.cluster.subnet_mapping["ExternalAz"] #=> String
resp.cluster.vpc_id #=> String
resp.cluster.certificates.cluster_csr #=> String
resp.cluster.certificates.hsm_certificate #=> String
resp.cluster.certificates.aws_hardware_certificate #=> String
resp.cluster.certificates.manufacturer_hardware_certificate #=> String
resp.cluster.certificates.cluster_certificate #=> String
resp.cluster.tag_list #=> Array
resp.cluster.tag_list[0].key #=> String
resp.cluster.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String) —

    The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.

Returns:

See Also:



688
689
690
691
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 688

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_hsm(params = {}) ⇒ Types::DeleteHsmResponse

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM’s elastic network interface (ENI), or the ID of the HSM’s ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Examples:

Request syntax with placeholder values


resp = client.delete_hsm({
  cluster_id: "ClusterId", # required
  hsm_id: "HsmId",
  eni_id: "EniId",
  eni_ip: "IpAddress",
})

Response structure


resp.hsm_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String) —

    The identifier (ID) of the cluster that contains the HSM that you are deleting.

  • :hsm_id (String) —

    The identifier (ID) of the HSM that you are deleting.

  • :eni_id (String) —

    The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

  • :eni_ip (String) —

    The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

Returns:

See Also:



734
735
736
737
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 734

def delete_hsm(params = {}, options = {})
  req = build_request(:delete_hsm, params)
  req.send_request(options)
end

#describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a ‘NextToken` value. Use this value in a subsequent `DescribeBackups` request to get more backups. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more backups to get.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_backups({
  next_token: "NextToken",
  max_results: 1,
  filters: {
    "Field" => ["String"],
  },
  sort_ascending: false,
})

Response structure


resp.backups #=> Array
resp.backups[0].backup_id #=> String
resp.backups[0].backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
resp.backups[0].cluster_id #=> String
resp.backups[0].create_timestamp #=> Time
resp.backups[0].copy_timestamp #=> Time
resp.backups[0].never_expires #=> Boolean
resp.backups[0].source_region #=> String
resp.backups[0].source_backup #=> String
resp.backups[0].source_cluster #=> String
resp.backups[0].delete_timestamp #=> Time
resp.backups[0].tag_list #=> Array
resp.backups[0].tag_list[0].key #=> String
resp.backups[0].tag_list[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The ‘NextToken` value that you received in the previous response. Use this value to get more backups.

  • :max_results (Integer) —

    The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a ‘NextToken` value.

  • :filters (Hash<String,Array>) —

    One or more filters to limit the items returned in the response.

    Use the ‘backupIds` filter to return only the specified backups. Specify backups by their backup identifier (ID).

    Use the ‘sourceBackupIds` filter to return only the backups created from a source backup. The `sourceBackupID` of a source backup is returned by the CopyBackupToRegion operation.

    Use the ‘clusterIds` filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the ‘states` filter to return only backups that match the specified state.

    Use the ‘neverExpires` filter to return backups filtered by the value in the `neverExpires` parameter. `True` returns all backups exempt from the backup retention policy. `False` returns all backups with a backup retention policy defined at the cluster.

  • :sort_ascending (Boolean) —

    Designates whether or not to sort the return backups by ascending chronological order of generation.

Returns:

See Also:



822
823
824
825
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 822

def describe_backups(params = {}, options = {})
  req = build_request(:describe_backups, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a ‘NextToken` value. Use this value in a subsequent `DescribeClusters` request to get more clusters. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more clusters to get.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_clusters({
  filters: {
    "Field" => ["String"],
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.clusters #=> Array
resp.clusters[0].backup_policy #=> String, one of "DEFAULT"
resp.clusters[0].backup_retention_policy.type #=> String, one of "DAYS"
resp.clusters[0].backup_retention_policy.value #=> String
resp.clusters[0].cluster_id #=> String
resp.clusters[0].create_timestamp #=> Time
resp.clusters[0].hsms #=> Array
resp.clusters[0].hsms[0].availability_zone #=> String
resp.clusters[0].hsms[0].cluster_id #=> String
resp.clusters[0].hsms[0].subnet_id #=> String
resp.clusters[0].hsms[0].eni_id #=> String
resp.clusters[0].hsms[0].eni_ip #=> String
resp.clusters[0].hsms[0].hsm_id #=> String
resp.clusters[0].hsms[0].state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
resp.clusters[0].hsms[0].state_message #=> String
resp.clusters[0].hsm_type #=> String
resp.clusters[0].pre_co_password #=> String
resp.clusters[0].security_group #=> String
resp.clusters[0].source_backup_id #=> String
resp.clusters[0].state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
resp.clusters[0].state_message #=> String
resp.clusters[0].subnet_mapping #=> Hash
resp.clusters[0].subnet_mapping["ExternalAz"] #=> String
resp.clusters[0].vpc_id #=> String
resp.clusters[0].certificates.cluster_csr #=> String
resp.clusters[0].certificates.hsm_certificate #=> String
resp.clusters[0].certificates.aws_hardware_certificate #=> String
resp.clusters[0].certificates.manufacturer_hardware_certificate #=> String
resp.clusters[0].certificates.cluster_certificate #=> String
resp.clusters[0].tag_list #=> Array
resp.clusters[0].tag_list[0].key #=> String
resp.clusters[0].tag_list[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

    One or more filters to limit the items returned in the response.

    Use the ‘clusterIds` filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the ‘vpcIds` filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

    Use the ‘states` filter to return only clusters that match the specified state.

  • :next_token (String) —

    The ‘NextToken` value that you received in the previous response. Use this value to get more clusters.

  • :max_results (Integer) —

    The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a ‘NextToken` value.

Returns:

See Also:



915
916
917
918
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 915

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#initialize_cluster(params = {}) ⇒ Types::InitializeClusterResponse

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA’s root certificate. Before you can claim a cluster, you must sign the cluster’s certificate signing request (CSR) with your issuing CA. To get the cluster’s CSR, use DescribeClusters.

Examples:

Request syntax with placeholder values


resp = client.initialize_cluster({
  cluster_id: "ClusterId", # required
  signed_cert: "Cert", # required
  trust_anchor: "Cert", # required
})

Response structure


resp.state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
resp.state_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String) —

    The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

  • :signed_cert (required, String) —

    The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

  • :trust_anchor (required, String) —

    The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

Returns:

See Also:



964
965
966
967
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 964

def initialize_cluster(params = {}, options = {})
  req = build_request(:initialize_cluster, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a ‘NextToken` value. Use this value in a subsequent `ListTags` request to get more tags. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more tags to get.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource_id: "ResourceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

  • :next_token (String) —

    The ‘NextToken` value that you received in the previous response. Use this value to get more tags.

  • :max_results (Integer) —

    The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a ‘NextToken` value.

Returns:

See Also:



1017
1018
1019
1020
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1017

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

#modify_backup_attributes(params = {}) ⇒ Types::ModifyBackupAttributesResponse

Modifies attributes for AWS CloudHSM backup.

Examples:

Request syntax with placeholder values


resp = client.modify_backup_attributes({
  backup_id: "BackupId", # required
  never_expires: false, # required
})

Response structure


resp.backup.backup_id #=> String
resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
resp.backup.cluster_id #=> String
resp.backup.create_timestamp #=> Time
resp.backup.copy_timestamp #=> Time
resp.backup.never_expires #=> Boolean
resp.backup.source_region #=> String
resp.backup.source_backup #=> String
resp.backup.source_cluster #=> String
resp.backup.delete_timestamp #=> Time
resp.backup.tag_list #=> Array
resp.backup.tag_list[0].key #=> String
resp.backup.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_id (required, String) —

    The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.

  • :never_expires (required, Boolean) —

    Specifies whether the service should exempt a backup from the retention policy for the cluster. ‘True` exempts a backup from the retention policy. `False` means the service applies the backup retention policy defined at the cluster.

Returns:

See Also:



1065
1066
1067
1068
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1065

def modify_backup_attributes(params = {}, options = {})
  req = build_request(:modify_backup_attributes, params)
  req.send_request(options)
end

#modify_cluster(params = {}) ⇒ Types::ModifyClusterResponse

Modifies AWS CloudHSM cluster.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster({
  backup_retention_policy: { # required
    type: "DAYS", # accepts DAYS
    value: "BackupRetentionValue",
  },
  cluster_id: "ClusterId", # required
})

Response structure


resp.cluster.backup_policy #=> String, one of "DEFAULT"
resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
resp.cluster.backup_retention_policy.value #=> String
resp.cluster.cluster_id #=> String
resp.cluster.create_timestamp #=> Time
resp.cluster.hsms #=> Array
resp.cluster.hsms[0].availability_zone #=> String
resp.cluster.hsms[0].cluster_id #=> String
resp.cluster.hsms[0].subnet_id #=> String
resp.cluster.hsms[0].eni_id #=> String
resp.cluster.hsms[0].eni_ip #=> String
resp.cluster.hsms[0].hsm_id #=> String
resp.cluster.hsms[0].state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
resp.cluster.hsms[0].state_message #=> String
resp.cluster.hsm_type #=> String
resp.cluster.pre_co_password #=> String
resp.cluster.security_group #=> String
resp.cluster.source_backup_id #=> String
resp.cluster.state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
resp.cluster.state_message #=> String
resp.cluster.subnet_mapping #=> Hash
resp.cluster.subnet_mapping["ExternalAz"] #=> String
resp.cluster.vpc_id #=> String
resp.cluster.certificates.cluster_csr #=> String
resp.cluster.certificates.hsm_certificate #=> String
resp.cluster.certificates.aws_hardware_certificate #=> String
resp.cluster.certificates.manufacturer_hardware_certificate #=> String
resp.cluster.certificates.cluster_certificate #=> String
resp.cluster.tag_list #=> Array
resp.cluster.tag_list[0].key #=> String
resp.cluster.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_retention_policy (required, Types::BackupRetentionPolicy) —

    A policy that defines how the service retains backups.

  • :cluster_id (required, String) —

    The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.

Returns:

See Also:



1131
1132
1133
1134
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1131

def modify_cluster(params = {}, options = {})
  req = build_request(:modify_cluster, params)
  req.send_request(options)
end

#restore_backup(params = {}) ⇒ Types::RestoreBackupResponse

Restores a specified AWS CloudHSM backup that is in the ‘PENDING_DELETION` state. For mor information on deleting a backup, see DeleteBackup.

Examples:

Request syntax with placeholder values


resp = client.restore_backup({
  backup_id: "BackupId", # required
})

Response structure


resp.backup.backup_id #=> String
resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
resp.backup.cluster_id #=> String
resp.backup.create_timestamp #=> Time
resp.backup.copy_timestamp #=> Time
resp.backup.never_expires #=> Boolean
resp.backup.source_region #=> String
resp.backup.source_backup #=> String
resp.backup.source_cluster #=> String
resp.backup.delete_timestamp #=> Time
resp.backup.tag_list #=> Array
resp.backup.tag_list[0].key #=> String
resp.backup.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :backup_id (required, String) —

    The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

Returns:

See Also:



1174
1175
1176
1177
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1174

def restore_backup(params = {}, options = {})
  req = build_request(:restore_backup, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_id: "ResourceId", # required
  tag_list: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

  • :tag_list (required, Array<Types::Tag>) —

    A list of one or more tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1207
1208
1209
1210
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1207

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_id: "ResourceId", # required
  tag_key_list: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.

  • :tag_key_list (required, Array<String>) —

    A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1236
1237
1238
1239
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1236

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1260
1261
1262
 
# File 'lib/aws-sdk-cloudhsmv2/client.rb', line 1260

def waiter_names
  []
end