Class: Aws::CloudHSM::Client

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

Overview

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

client = Aws::CloudHSM::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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and 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::InstanceProfileCredentials` 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)
  • :account_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, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

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

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :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::CloudHSM::EndpointProvider) —

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

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

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



474
475
476
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 474

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. 



1677
1678
1679
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1677

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. 



1680
1681
1682
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1680

def errors_module
  Errors
end

Instance Method Details

#add_tags_to_resource(params = {}) ⇒ Types::AddTagsToResourceResponse

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

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

Each tag consists of a key and a value. Tag keys must be unique to each resource.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.add_tags_to_resource({
  resource_arn: "String", # required
  tag_list: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

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

    One or more tags.

Returns:

See Also:



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

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

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


1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1650

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CloudHSM')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-cloudhsm'
  context[:gem_version] = '1.66.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_hapg(params = {}) ⇒ Types::CreateHapgResponse

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

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.create_hapg({
  label: "Label", # required
})

Response structure


resp.hapg_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :label (required, String) —

    The label of the new high-availability partition group.

Returns:

See Also:



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

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

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

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

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the ‘CreateHsm` operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the [AWS Support Center], create a new case, and select **Account and Billing Support**.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to ‘RUNNING`.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/ [7]: console.aws.amazon.com/support/home

Examples:

Request syntax with placeholder values


resp = client.create_hsm({
  subnet_id: "SubnetId", # required
  ssh_key: "SshKey", # required
  eni_ip: "IpAddress",
  iam_role_arn: "IamRoleArn", # required
  external_id: "ExternalId",
  subscription_type: "PRODUCTION", # required, accepts PRODUCTION
  client_token: "ClientToken",
  syslog_ip: "IpAddress",
})

Response structure


resp.hsm_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :subnet_id (required, String) —

    The identifier of the subnet in your VPC in which to place the HSM.

  • :ssh_key (required, String) —

    The SSH public key to install on the HSM.

  • :eni_ip (String) —

    The IP address to assign to the HSM’s ENI.

    If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

  • :iam_role_arn (required, String) —

    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

  • :external_id (String) —

    The external ID from ‘IamRoleArn`, if present.

  • :subscription_type (required, String) —

    Specifies the type of subscription for the HSM.

    • PRODUCTION - The HSM is being used in a production environment.

    • TRIAL - The HSM is being used in a product trial.

  • :client_token (String) —

    A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

  • :syslog_ip (String) —

    The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Returns:

See Also:



677
678
679
680
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 677

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

#create_luna_client(params = {}) ⇒ Types::CreateLunaClientResponse

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

Creates an HSM client.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.create_luna_client({
  label: "ClientLabel",
  certificate: "Certificate", # required
})

Response structure


resp.client_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :label (String) —

    The label for the client.

  • :certificate (required, String) —

    The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

Returns:

See Also:



728
729
730
731
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 728

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

#delete_hapg(params = {}) ⇒ Types::DeleteHapgResponse

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

Deletes a high-availability partition group.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.delete_hapg({
  hapg_arn: "HapgArn", # required
})

Response structure


resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hapg_arn (required, String) —

    The ARN of the high-availability partition group to delete.

Returns:

See Also:



774
775
776
777
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 774

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

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

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

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.delete_hsm({
  hsm_arn: "HsmArn", # required
})

Response structure


resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hsm_arn (required, String) —

    The ARN of the HSM to delete.

Returns:

See Also:



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

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

#delete_luna_client(params = {}) ⇒ Types::DeleteLunaClientResponse

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

Deletes a client.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.delete_luna_client({
  client_arn: "ClientArn", # required
})

Response structure


resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_arn (required, String) —

    The ARN of the client to delete.

Returns:

See Also:



867
868
869
870
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 867

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

#describe_hapg(params = {}) ⇒ Types::DescribeHapgResponse

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

Retrieves information about a high-availability partition group.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.describe_hapg({
  hapg_arn: "HapgArn", # required
})

Response structure


resp.hapg_arn #=> String
resp.hapg_serial #=> String
resp.hsms_last_action_failed #=> Array
resp.hsms_last_action_failed[0] #=> String
resp.hsms_pending_deletion #=> Array
resp.hsms_pending_deletion[0] #=> String
resp.hsms_pending_registration #=> Array
resp.hsms_pending_registration[0] #=> String
resp.label #=> String
resp.last_modified_timestamp #=> String
resp.partition_serial_list #=> Array
resp.partition_serial_list[0] #=> String
resp.state #=> String, one of "READY", "UPDATING", "DEGRADED"

Parameters:

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

    ({})

Options Hash (params):

  • :hapg_arn (required, String) —

    The ARN of the high-availability partition group to describe.

Returns:

See Also:



933
934
935
936
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 933

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

#describe_hsm(params = {}) ⇒ Types::DescribeHsmResponse

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

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.describe_hsm({
  hsm_arn: "HsmArn",
  hsm_serial_number: "HsmSerialNumber",
})

Response structure


resp.hsm_arn #=> String
resp.status #=> String, one of "PENDING", "RUNNING", "UPDATING", "SUSPENDED", "TERMINATING", "TERMINATED", "DEGRADED"
resp.status_details #=> String
resp.availability_zone #=> String
resp.eni_id #=> String
resp.eni_ip #=> String
resp.subscription_type #=> String, one of "PRODUCTION"
resp.subscription_start_date #=> String
resp.subscription_end_date #=> String
resp.vpc_id #=> String
resp.subnet_id #=> String
resp.iam_role_arn #=> String
resp.serial_number #=> String
resp.vendor_name #=> String
resp.hsm_type #=> String
resp.software_version #=> String
resp.ssh_public_key #=> String
resp.ssh_key_last_updated #=> String
resp.server_cert_uri #=> String
resp.server_cert_last_updated #=> String
resp.partitions #=> Array
resp.partitions[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hsm_arn (String) —

    The ARN of the HSM. Either the ‘HsmArn` or the `SerialNumber` parameter must be specified.

  • :hsm_serial_number (String) —

    The serial number of the HSM. Either the ‘HsmArn` or the `HsmSerialNumber` parameter must be specified.

Returns:

See Also:



1027
1028
1029
1030
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1027

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

#describe_luna_client(params = {}) ⇒ Types::DescribeLunaClientResponse

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

Retrieves information about an HSM client.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.describe_luna_client({
  client_arn: "ClientArn",
  certificate_fingerprint: "CertificateFingerprint",
})

Response structure


resp.client_arn #=> String
resp.certificate #=> String
resp.certificate_fingerprint #=> String
resp.last_modified_timestamp #=> String
resp.label #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_arn (String) —

    The ARN of the client.

  • :certificate_fingerprint (String) —

    The certificate fingerprint.

Returns:

See Also:



1085
1086
1087
1088
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1085

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

#get_config(params = {}) ⇒ Types::GetConfigResponse

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

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.get_config({
  client_arn: "ClientArn", # required
  client_version: "5.1", # required, accepts 5.1, 5.3
  hapg_list: ["HapgArn"], # required
})

Response structure


resp.config_type #=> String
resp.config_file #=> String
resp.config_cred #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_arn (required, String) —

    The ARN of the client.

  • :client_version (required, String) —

    The client version.

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

    A list of ARNs that identify the high-availability partition groups that are associated with the client.

Returns:

See Also:



1145
1146
1147
1148
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1145

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

#list_available_zones(params = {}) ⇒ Types::ListAvailableZonesResponse

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

Lists the Availability Zones that have available AWS CloudHSM capacity.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Response structure


resp.az_list #=> Array
resp.az_list[0] #=> String

Parameters:

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

    ({})

Returns:

See Also:



1184
1185
1186
1187
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1184

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

#list_hapgs(params = {}) ⇒ Types::ListHapgsResponse

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

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the ‘NextToken` member. If more results are available, the `NextToken` member of the response contains a token that you pass in the next call to `ListHapgs` to retrieve the next set of items.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.list_hapgs({
  next_token: "PaginationToken",
})

Response structure


resp.hapg_list #=> Array
resp.hapg_list[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The ‘NextToken` value from a previous call to `ListHapgs`. Pass null if this is the first call.

Returns:

See Also:



1239
1240
1241
1242
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1239

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

#list_hsms(params = {}) ⇒ Types::ListHsmsResponse

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

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the ‘NextToken` member. If more results are available, the `NextToken` member of the response contains a token that you pass in the next call to `ListHsms` to retrieve the next set of items.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.list_hsms({
  next_token: "PaginationToken",
})

Response structure


resp.hsm_list #=> Array
resp.hsm_list[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The ‘NextToken` value from a previous call to `ListHsms`. Pass null if this is the first call.

Returns:

See Also:



1295
1296
1297
1298
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1295

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

#list_luna_clients(params = {}) ⇒ Types::ListLunaClientsResponse

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

Lists all of the clients.

This operation supports pagination with the use of the ‘NextToken` member. If more results are available, the `NextToken` member of the response contains a token that you pass in the next call to `ListLunaClients` to retrieve the next set of items.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.list_luna_clients({
  next_token: "PaginationToken",
})

Response structure


resp.client_list #=> Array
resp.client_list[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The ‘NextToken` value from a previous call to `ListLunaClients`. Pass null if this is the first call.

Returns:

See Also:



1350
1351
1352
1353
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1350

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Returns a list of all tags for the specified AWS CloudHSM resource.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

Returns:

See Also:



1398
1399
1400
1401
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1398

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

#modify_hapg(params = {}) ⇒ Types::ModifyHapgResponse

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

Modifies an existing high-availability partition group.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.modify_hapg({
  hapg_arn: "HapgArn", # required
  label: "Label",
  partition_serial_list: ["PartitionSerial"],
})

Response structure


resp.hapg_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hapg_arn (required, String) —

    The ARN of the high-availability partition group to modify.

  • :label (String) —

    The new label for the high-availability partition group.

  • :partition_serial_list (Array<String>) —

    The list of partition serial numbers to make members of the high-availability partition group.

Returns:

See Also:



1453
1454
1455
1456
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1453

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

#modify_hsm(params = {}) ⇒ Types::ModifyHsmResponse

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

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.modify_hsm({
  hsm_arn: "HsmArn", # required
  subnet_id: "SubnetId",
  eni_ip: "IpAddress",
  iam_role_arn: "IamRoleArn",
  external_id: "ExternalId",
  syslog_ip: "IpAddress",
})

Response structure


resp.hsm_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hsm_arn (required, String) —

    The ARN of the HSM to modify.

  • :subnet_id (String) —

    The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

  • :eni_ip (String) —

    The new IP address for the elastic network interface (ENI) attached to the HSM.

    If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

  • :iam_role_arn (String) —

    The new IAM role ARN.

  • :external_id (String) —

    The new external ID.

  • :syslog_ip (String) —

    The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Returns:

See Also:



1532
1533
1534
1535
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1532

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

#modify_luna_client(params = {}) ⇒ Types::ModifyLunaClientResponse

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

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client’s HSMs.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.modify_luna_client({
  client_arn: "ClientArn", # required
  certificate: "Certificate", # required
})

Response structure


resp.client_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_arn (required, String) —

    The ARN of the client.

  • :certificate (required, String) —

    The new certificate for the client.

Returns:

See Also:



1585
1586
1587
1588
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1585

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

#remove_tags_from_resource(params = {}) ⇒ Types::RemoveTagsFromResourceResponse

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

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

[1]: aws.amazon.com/cloudhsm/faqs-classic/ [2]: docs.aws.amazon.com/cloudhsm/classic/userguide/ [3]: docs.aws.amazon.com/cloudhsm/classic/APIReference/ [4]: aws.amazon.com/cloudhsm/ [5]: docs.aws.amazon.com/cloudhsm/latest/userguide/ [6]: docs.aws.amazon.com/cloudhsm/latest/APIReference/

Examples:

Request syntax with placeholder values


resp = client.remove_tags_from_resource({
  resource_arn: "String", # required
  tag_key_list: ["TagKey"], # required
})

Response structure


resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

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

    The tag key or keys to remove.

    Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

Returns:

See Also:



1641
1642
1643
1644
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1641

def remove_tags_from_resource(params = {}, options = {})
  req = build_request(:remove_tags_from_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. 


1670
1671
1672
 
# File 'lib/aws-sdk-cloudhsm/client.rb', line 1670

def waiter_names
  []
end