lib/aws-sdk-cloudhsmv2/client.rb in aws-sdk-cloudhsmv2-1.19.0 vs lib/aws-sdk-cloudhsmv2/client.rb in aws-sdk-cloudhsmv2-1.20.0

- old
+ new

@@ -270,19 +270,27 @@ # The AWS region that will contain your copied CloudHSM cluster backup. # # @option params [required, String] :backup_id # The ID of the backup that will be copied to the destination region. # + # @option params [Array<Types::Tag>] :tag_list + # # @return [Types::CopyBackupToRegionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CopyBackupToRegionResponse#destination_backup #destination_backup} => Types::DestinationBackup # # @example 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 + # }, + # ], # }) # # @example Response structure # # resp.destination_backup.create_timestamp #=> Time @@ -317,20 +325,28 @@ # @option params [String] :source_backup_id # 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. # + # @option params [Array<Types::Tag>] :tag_list + # # @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateClusterResponse#cluster #cluster} => Types::Cluster # # @example Request syntax with placeholder values # # resp = client.create_cluster({ # subnet_ids: ["SubnetId"], # required # hsm_type: "HsmType", # required # source_backup_id: "BackupId", + # tag_list: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], # }) # # @example Response structure # # resp.cluster.backup_policy #=> String, one of "DEFAULT" @@ -357,10 +373,13 @@ # 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster AWS API Documentation # # @overload create_cluster(params = {}) # @param [Hash] params ({}) @@ -417,12 +436,12 @@ req = build_request(:create_hsm, params) req.send_request(options) end # 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 + # to 7 days after the DeleteBackup request is made. For more information + # on restoring a backup, see RestoreBackup. # # @option params [required, String] :backup_id # The ID of the backup to be deleted. To find the ID of a backup, use # the DescribeBackups operation. # @@ -445,10 +464,13 @@ # 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 + # resp.backup.tag_list #=> Array + # resp.backup.tag_list[0].key #=> String + # resp.backup.tag_list[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup AWS API Documentation # # @overload delete_backup(params = {}) # @param [Hash] params ({}) @@ -502,10 +524,13 @@ # 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster AWS API Documentation # # @overload delete_cluster(params = {}) # @param [Hash] params ({}) @@ -593,10 +618,12 @@ # # Use the `states` filter to return only backups that match the # specified state. # # @option params [Boolean] :sort_ascending + # Designates whether or not to sort the return backups by ascending + # chronological order of generation. # # @return [Types::DescribeBackupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeBackupsResponse#backups #backups} => Array&lt;Types::Backup&gt; # * {Types::DescribeBackupsResponse#next_token #next_token} => String @@ -622,10 +649,13 @@ # 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.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 # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups AWS API Documentation # # @overload describe_backups(params = {}) @@ -708,10 +738,13 @@ # 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters AWS API Documentation # # @overload describe_clusters(params = {}) @@ -736,15 +769,14 @@ # authority (CA). The certificate must be in PEM format and can contain # a maximum of 5000 characters. # # @option params [required, String] :trust_anchor # 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. + # 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. # # @return [Types::InitializeClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::InitializeClusterResponse#state #state} => String # * {Types::InitializeClusterResponse#state_message #state_message} => String @@ -799,11 +831,11 @@ # * {Types::ListTagsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_tags({ - # resource_id: "ClusterId", # required + # resource_id: "ResourceId", # required # next_token: "NextToken", # max_results: 1, # }) # # @example Response structure @@ -821,11 +853,11 @@ req = build_request(:list_tags, params) req.send_request(options) end # Restores a specified AWS CloudHSM backup that is in the - # `PENDING_DELETION` state. For more information on deleting a backup, + # `PENDING_DELETION` state. For mor information on deleting a backup, # see DeleteBackup. # # @option params [required, String] :backup_id # The ID of the backup to be restored. To find the ID of a backup, use # the DescribeBackups operation. @@ -849,10 +881,13 @@ # 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 + # resp.backup.tag_list #=> Array + # resp.backup.tag_list[0].key #=> String + # resp.backup.tag_list[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup AWS API Documentation # # @overload restore_backup(params = {}) # @param [Hash] params ({}) @@ -874,11 +909,11 @@ # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ - # resource_id: "ClusterId", # required + # resource_id: "ResourceId", # required # tag_list: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, @@ -908,11 +943,11 @@ # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ - # resource_id: "ClusterId", # required + # resource_id: "ResourceId", # required # tag_key_list: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource AWS API Documentation # @@ -934,10 +969,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-cloudhsmv2' - context[:gem_version] = '1.19.0' + context[:gem_version] = '1.20.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated