You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudHSMV2::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :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.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid 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. Defaults to false.

  • :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.

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :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.

    @see https://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 and auth errors from expired credentials.

  • :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.

  • :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

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

  • :validate_params (Boolean) — default: true —

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_read_timeout (Integer) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

  • :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.



261
262
263
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#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
})

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.

Returns:

See Also:



297
298
299
300
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 297

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({
  subnet_ids: ["SubnetId"], # required
  hsm_type: "HsmType", # required
  source_backup_id: "BackupId",
})

Response structure


resp.cluster.backup_policy #=> String, one of "DEFAULT"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :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.

Returns:

See Also:



367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 367

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:



416
417
418
419
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 416

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. 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.source_region #=> String
resp.backup.source_backup #=> String
resp.backup.source_cluster #=> String
resp.backup.delete_timestamp #=> Time

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:



455
456
457
458
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 455

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.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

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:



512
513
514
515
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 512

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:



558
559
560
561
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 558

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.

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].source_region #=> String
resp.backups[0].source_backup #=> String
resp.backups[0].source_cluster #=> String
resp.backups[0].delete_timestamp #=> Time
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.

  • :sort_ascending (Boolean)

Returns:

See Also:



633
634
635
636
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 633

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.

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].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.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:



719
720
721
722
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 719

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. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.

Returns:

See Also:



769
770
771
772
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 769

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.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource_id: "ClusterId", # 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:



820
821
822
823
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 820

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, 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 more 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.source_region #=> String
resp.backup.source_backup #=> String
resp.backup.source_cluster #=> String
resp.backup.delete_timestamp #=> Time

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:



859
860
861
862
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 859

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: "ClusterId", # 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:



892
893
894
895
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 892

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: "ClusterId", # 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:



921
922
923
924
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 921

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