aws-sdk-cloudhsmv2 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7324a55d0570f982e1801db0f6436f1a871ed699ef2cbb450612485f585c6d84
-  data.tar.gz: d85811438bd8b5fe12b1d67700849a487cea2841ca1e786b15ef5cfc4918ccfa
+  metadata.gz: d6067f89da19df6f5e4541041c928413df3524459d234dff278c627f272814c7
+  data.tar.gz: 9ba74d44944d0d848084cbd11037a5e2ba7a8c2efd407d822e4726b1cfc244b8
 SHA512:
-  metadata.gz: 33b9a1076d6d84dc544390642670ff7e548078ba30e5264847a1e2df2587527c2034976a9cb8c91eb7391cc69e3f7912252c508b0e14e18f81bccb2784074031
-  data.tar.gz: 1da2a0613928b9350d8c562f6434cc1417343451d652b7acdc9845d342bd707468c17ac28b09a842f0eb1419d8ec77c94564a5cc40485eca918db472a2021830
+  metadata.gz: 4ee443d5b4e217ed44b021545e6e2dffe3165de5259104439cbca121e128292ac3f43f995e41cde877068bbd6a2cfd5d968e99e830921f078719f61b3802b63b
+  data.tar.gz: 55f86adbf106dfea17d4b4fe9d33441d9c8fdf565e9694fbbb1f98bff6f48e5022aab003a441d3f7676f72fe2597f2686aabb9e97b7de43fb04ddd90a4712932

data/lib/aws-sdk-cloudhsmv2.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-cloudhsmv2/customizations'
 # @!group service
 module Aws::CloudHSMV2
 
-  GEM_VERSION = '1.30.0'
+  GEM_VERSION = '1.31.0'
 
 end

data/lib/aws-sdk-cloudhsmv2/client.rb

@@ -386,14 +386,8 @@ module Aws::CloudHSMV2
 
     # Creates a new AWS CloudHSM cluster.
     #
-    # @option params [required, Array<String>] :subnet_ids
-    #   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.
+    # @option params [Types::BackupRetentionPolicy] :backup_retention_policy
+    #   A policy that defines how the service retains backups.
     #
     # @option params [required, String] :hsm_type
     #   The type of HSM to use in the cluster. Currently the only allowed
@@ -404,6 +398,15 @@ module Aws::CloudHSMV2
     #   to restore the cluster from a backup instead of creating a new
     #   cluster. To find the backup ID, use DescribeBackups.
     #
+    # @option params [required, Array<String>] :subnet_ids
+    #   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.
+    #
     # @option params [Array<Types::Tag>] :tag_list
     #   Tags to apply to the CloudHSM cluster during creation.
     #
@@ -414,9 +417,13 @@ module Aws::CloudHSMV2
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_cluster({
-    #     subnet_ids: ["SubnetId"], # required
+    #     backup_retention_policy: {
+    #       type: "DAYS", # accepts DAYS
+    #       value: "BackupRetentionValue",
+    #     },
     #     hsm_type: "HsmType", # required
     #     source_backup_id: "BackupId",
+    #     subnet_ids: ["SubnetId"], # required
     #     tag_list: [
     #       {
     #         key: "TagKey", # required
@@ -428,6 +435,8 @@ module Aws::CloudHSMV2
     # @example Response structure
     #
     #   resp.cluster.backup_policy #=> String, one of "DEFAULT"
+    #   resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
+    #   resp.cluster.backup_retention_policy.value #=> String
     #   resp.cluster.cluster_id #=> String
     #   resp.cluster.create_timestamp #=> Time
     #   resp.cluster.hsms #=> Array
@@ -540,6 +549,7 @@ module Aws::CloudHSMV2
     #   resp.backup.cluster_id #=> String
     #   resp.backup.create_timestamp #=> Time
     #   resp.backup.copy_timestamp #=> Time
+    #   resp.backup.never_expires #=> Boolean
     #   resp.backup.source_region #=> String
     #   resp.backup.source_backup #=> String
     #   resp.backup.source_cluster #=> String
@@ -579,6 +589,8 @@ module Aws::CloudHSMV2
     # @example Response structure
     #
     #   resp.cluster.backup_policy #=> String, one of "DEFAULT"
+    #   resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
+    #   resp.cluster.backup_retention_policy.value #=> String
     #   resp.cluster.cluster_id #=> String
     #   resp.cluster.create_timestamp #=> Time
     #   resp.cluster.hsms #=> Array
@@ -697,6 +709,11 @@ module Aws::CloudHSMV2
     #   Use the `states` filter to return only backups that match the
     #   specified state.
     #
+    #   Use the `neverExpires` filter to return backups filtered by the value
+    #   in the `neverExpires` parameter. `True` returns all backups exempt
+    #   from the backup retention policy. `False` returns all backups with a
+    #   backup retention policy defined at the cluster.
+    #
     # @option params [Boolean] :sort_ascending
     #   Designates whether or not to sort the return backups by ascending
     #   chronological order of generation.
@@ -727,6 +744,7 @@ module Aws::CloudHSMV2
     #   resp.backups[0].cluster_id #=> String
     #   resp.backups[0].create_timestamp #=> Time
     #   resp.backups[0].copy_timestamp #=> Time
+    #   resp.backups[0].never_expires #=> Boolean
     #   resp.backups[0].source_region #=> String
     #   resp.backups[0].source_backup #=> String
     #   resp.backups[0].source_cluster #=> String
@@ -797,6 +815,8 @@ module Aws::CloudHSMV2
     #
     #   resp.clusters #=> Array
     #   resp.clusters[0].backup_policy #=> String, one of "DEFAULT"
+    #   resp.clusters[0].backup_retention_policy.type #=> String, one of "DAYS"
+    #   resp.clusters[0].backup_retention_policy.value #=> String
     #   resp.clusters[0].cluster_id #=> String
     #   resp.clusters[0].create_timestamp #=> Time
     #   resp.clusters[0].hsms #=> Array
@@ -938,6 +958,120 @@ module Aws::CloudHSMV2
       req.send_request(options)
     end
 
+    # Modifies attributes for AWS CloudHSM backup.
+    #
+    # @option params [required, String] :backup_id
+    #   The identifier (ID) of the backup to modify. To find the ID of a
+    #   backup, use the DescribeBackups operation.
+    #
+    # @option params [required, Boolean] :never_expires
+    #   Specifies whether the service should exempt a backup from the
+    #   retention policy for the cluster. `True` exempts a backup from the
+    #   retention policy. `False` means the service applies the backup
+    #   retention policy defined at the cluster.
+    #
+    # @return [Types::ModifyBackupAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ModifyBackupAttributesResponse#backup #backup} => Types::Backup
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.modify_backup_attributes({
+    #     backup_id: "BackupId", # required
+    #     never_expires: false, # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.backup.backup_id #=> String
+    #   resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
+    #   resp.backup.cluster_id #=> String
+    #   resp.backup.create_timestamp #=> Time
+    #   resp.backup.copy_timestamp #=> Time
+    #   resp.backup.never_expires #=> Boolean
+    #   resp.backup.source_region #=> String
+    #   resp.backup.source_backup #=> String
+    #   resp.backup.source_cluster #=> String
+    #   resp.backup.delete_timestamp #=> Time
+    #   resp.backup.tag_list #=> Array
+    #   resp.backup.tag_list[0].key #=> String
+    #   resp.backup.tag_list[0].value #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyBackupAttributes AWS API Documentation
+    #
+    # @overload modify_backup_attributes(params = {})
+    # @param [Hash] params ({})
+    def modify_backup_attributes(params = {}, options = {})
+      req = build_request(:modify_backup_attributes, params)
+      req.send_request(options)
+    end
+
+    # Modifies AWS CloudHSM cluster.
+    #
+    # @option params [required, Types::BackupRetentionPolicy] :backup_retention_policy
+    #   A policy that defines how the service retains backups.
+    #
+    # @option params [required, String] :cluster_id
+    #   The identifier (ID) of the cluster that you want to modify. To find
+    #   the cluster ID, use DescribeClusters.
+    #
+    # @return [Types::ModifyClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ModifyClusterResponse#cluster #cluster} => Types::Cluster
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.modify_cluster({
+    #     backup_retention_policy: { # required
+    #       type: "DAYS", # accepts DAYS
+    #       value: "BackupRetentionValue",
+    #     },
+    #     cluster_id: "ClusterId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.cluster.backup_policy #=> String, one of "DEFAULT"
+    #   resp.cluster.backup_retention_policy.type #=> String, one of "DAYS"
+    #   resp.cluster.backup_retention_policy.value #=> String
+    #   resp.cluster.cluster_id #=> String
+    #   resp.cluster.create_timestamp #=> Time
+    #   resp.cluster.hsms #=> Array
+    #   resp.cluster.hsms[0].availability_zone #=> String
+    #   resp.cluster.hsms[0].cluster_id #=> String
+    #   resp.cluster.hsms[0].subnet_id #=> String
+    #   resp.cluster.hsms[0].eni_id #=> String
+    #   resp.cluster.hsms[0].eni_ip #=> String
+    #   resp.cluster.hsms[0].hsm_id #=> String
+    #   resp.cluster.hsms[0].state #=> String, one of "CREATE_IN_PROGRESS", "ACTIVE", "DEGRADED", "DELETE_IN_PROGRESS", "DELETED"
+    #   resp.cluster.hsms[0].state_message #=> String
+    #   resp.cluster.hsm_type #=> String
+    #   resp.cluster.pre_co_password #=> String
+    #   resp.cluster.security_group #=> String
+    #   resp.cluster.source_backup_id #=> String
+    #   resp.cluster.state #=> String, one of "CREATE_IN_PROGRESS", "UNINITIALIZED", "INITIALIZE_IN_PROGRESS", "INITIALIZED", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DEGRADED"
+    #   resp.cluster.state_message #=> String
+    #   resp.cluster.subnet_mapping #=> Hash
+    #   resp.cluster.subnet_mapping["ExternalAz"] #=> String
+    #   resp.cluster.vpc_id #=> String
+    #   resp.cluster.certificates.cluster_csr #=> String
+    #   resp.cluster.certificates.hsm_certificate #=> String
+    #   resp.cluster.certificates.aws_hardware_certificate #=> String
+    #   resp.cluster.certificates.manufacturer_hardware_certificate #=> String
+    #   resp.cluster.certificates.cluster_certificate #=> String
+    #   resp.cluster.tag_list #=> Array
+    #   resp.cluster.tag_list[0].key #=> String
+    #   resp.cluster.tag_list[0].value #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyCluster AWS API Documentation
+    #
+    # @overload modify_cluster(params = {})
+    # @param [Hash] params ({})
+    def modify_cluster(params = {}, options = {})
+      req = build_request(:modify_cluster, params)
+      req.send_request(options)
+    end
+
     # Restores a specified AWS CloudHSM backup that is in the
     # `PENDING_DELETION` state. For mor information on deleting a backup,
     # see DeleteBackup.
@@ -963,6 +1097,7 @@ module Aws::CloudHSMV2
     #   resp.backup.cluster_id #=> String
     #   resp.backup.create_timestamp #=> Time
     #   resp.backup.copy_timestamp #=> Time
+    #   resp.backup.never_expires #=> Boolean
     #   resp.backup.source_region #=> String
     #   resp.backup.source_backup #=> String
     #   resp.backup.source_cluster #=> String
@@ -1055,7 +1190,7 @@ module Aws::CloudHSMV2
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudhsmv2'
-      context[:gem_version] = '1.30.0'
+      context[:gem_version] = '1.31.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudhsmv2/client_api.rb

@@ -16,8 +16,12 @@ module Aws::CloudHSMV2
     Backup = Shapes::StructureShape.new(name: 'Backup')
     BackupId = Shapes::StringShape.new(name: 'BackupId')
     BackupPolicy = Shapes::StringShape.new(name: 'BackupPolicy')
+    BackupRetentionPolicy = Shapes::StructureShape.new(name: 'BackupRetentionPolicy')
+    BackupRetentionType = Shapes::StringShape.new(name: 'BackupRetentionType')
+    BackupRetentionValue = Shapes::StringShape.new(name: 'BackupRetentionValue')
     BackupState = Shapes::StringShape.new(name: 'BackupState')
     Backups = Shapes::ListShape.new(name: 'Backups')
+    BackupsMaxSize = Shapes::IntegerShape.new(name: 'BackupsMaxSize')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     Cert = Shapes::StringShape.new(name: 'Cert')
     Certificates = Shapes::StructureShape.new(name: 'Certificates')
@@ -31,6 +35,7 @@ module Aws::CloudHSMV2
     ClusterId = Shapes::StringShape.new(name: 'ClusterId')
     ClusterState = Shapes::StringShape.new(name: 'ClusterState')
     Clusters = Shapes::ListShape.new(name: 'Clusters')
+    ClustersMaxSize = Shapes::IntegerShape.new(name: 'ClustersMaxSize')
     CopyBackupToRegionRequest = Shapes::StructureShape.new(name: 'CopyBackupToRegionRequest')
     CopyBackupToRegionResponse = Shapes::StructureShape.new(name: 'CopyBackupToRegionResponse')
     CreateClusterRequest = Shapes::StructureShape.new(name: 'CreateClusterRequest')
@@ -64,6 +69,10 @@ module Aws::CloudHSMV2
     ListTagsRequest = Shapes::StructureShape.new(name: 'ListTagsRequest')
     ListTagsResponse = Shapes::StructureShape.new(name: 'ListTagsResponse')
     MaxSize = Shapes::IntegerShape.new(name: 'MaxSize')
+    ModifyBackupAttributesRequest = Shapes::StructureShape.new(name: 'ModifyBackupAttributesRequest')
+    ModifyBackupAttributesResponse = Shapes::StructureShape.new(name: 'ModifyBackupAttributesResponse')
+    ModifyClusterRequest = Shapes::StructureShape.new(name: 'ModifyClusterRequest')
+    ModifyClusterResponse = Shapes::StructureShape.new(name: 'ModifyClusterResponse')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     PreCoPassword = Shapes::StringShape.new(name: 'PreCoPassword')
     Region = Shapes::StringShape.new(name: 'Region')
@@ -94,6 +103,7 @@ module Aws::CloudHSMV2
     Backup.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, location_name: "ClusterId"))
     Backup.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateTimestamp"))
     Backup.add_member(:copy_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CopyTimestamp"))
+    Backup.add_member(:never_expires, Shapes::ShapeRef.new(shape: Boolean, location_name: "NeverExpires"))
     Backup.add_member(:source_region, Shapes::ShapeRef.new(shape: Region, location_name: "SourceRegion"))
     Backup.add_member(:source_backup, Shapes::ShapeRef.new(shape: BackupId, location_name: "SourceBackup"))
     Backup.add_member(:source_cluster, Shapes::ShapeRef.new(shape: ClusterId, location_name: "SourceCluster"))
@@ -101,6 +111,10 @@ module Aws::CloudHSMV2
     Backup.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
     Backup.struct_class = Types::Backup
 
+    BackupRetentionPolicy.add_member(:type, Shapes::ShapeRef.new(shape: BackupRetentionType, location_name: "Type"))
+    BackupRetentionPolicy.add_member(:value, Shapes::ShapeRef.new(shape: BackupRetentionValue, location_name: "Value"))
+    BackupRetentionPolicy.struct_class = Types::BackupRetentionPolicy
+
     Backups.member = Shapes::ShapeRef.new(shape: Backup)
 
     Certificates.add_member(:cluster_csr, Shapes::ShapeRef.new(shape: Cert, location_name: "ClusterCsr"))
@@ -129,6 +143,7 @@ module Aws::CloudHSMV2
     CloudHsmTagException.struct_class = Types::CloudHsmTagException
 
     Cluster.add_member(:backup_policy, Shapes::ShapeRef.new(shape: BackupPolicy, location_name: "BackupPolicy"))
+    Cluster.add_member(:backup_retention_policy, Shapes::ShapeRef.new(shape: BackupRetentionPolicy, location_name: "BackupRetentionPolicy"))
     Cluster.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, location_name: "ClusterId"))
     Cluster.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateTimestamp"))
     Cluster.add_member(:hsms, Shapes::ShapeRef.new(shape: Hsms, location_name: "Hsms"))
@@ -154,9 +169,10 @@ module Aws::CloudHSMV2
     CopyBackupToRegionResponse.add_member(:destination_backup, Shapes::ShapeRef.new(shape: DestinationBackup, location_name: "DestinationBackup"))
     CopyBackupToRegionResponse.struct_class = Types::CopyBackupToRegionResponse
 
-    CreateClusterRequest.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "SubnetIds"))
+    CreateClusterRequest.add_member(:backup_retention_policy, Shapes::ShapeRef.new(shape: BackupRetentionPolicy, location_name: "BackupRetentionPolicy"))
     CreateClusterRequest.add_member(:hsm_type, Shapes::ShapeRef.new(shape: HsmType, required: true, location_name: "HsmType"))
     CreateClusterRequest.add_member(:source_backup_id, Shapes::ShapeRef.new(shape: BackupId, location_name: "SourceBackupId"))
+    CreateClusterRequest.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "SubnetIds"))
     CreateClusterRequest.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
     CreateClusterRequest.struct_class = Types::CreateClusterRequest
 
@@ -193,7 +209,7 @@ module Aws::CloudHSMV2
     DeleteHsmResponse.struct_class = Types::DeleteHsmResponse
 
     DescribeBackupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
-    DescribeBackupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize, location_name: "MaxResults"))
+    DescribeBackupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: BackupsMaxSize, location_name: "MaxResults"))
     DescribeBackupsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
     DescribeBackupsRequest.add_member(:sort_ascending, Shapes::ShapeRef.new(shape: Boolean, location_name: "SortAscending"))
     DescribeBackupsRequest.struct_class = Types::DescribeBackupsRequest
@@ -204,7 +220,7 @@ module Aws::CloudHSMV2
 
     DescribeClustersRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
     DescribeClustersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
-    DescribeClustersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize, location_name: "MaxResults"))
+    DescribeClustersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ClustersMaxSize, location_name: "MaxResults"))
     DescribeClustersRequest.struct_class = Types::DescribeClustersRequest
 
     DescribeClustersResponse.add_member(:clusters, Shapes::ShapeRef.new(shape: Clusters, location_name: "Clusters"))
@@ -253,6 +269,20 @@ module Aws::CloudHSMV2
     ListTagsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListTagsResponse.struct_class = Types::ListTagsResponse
 
+    ModifyBackupAttributesRequest.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
+    ModifyBackupAttributesRequest.add_member(:never_expires, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "NeverExpires"))
+    ModifyBackupAttributesRequest.struct_class = Types::ModifyBackupAttributesRequest
+
+    ModifyBackupAttributesResponse.add_member(:backup, Shapes::ShapeRef.new(shape: Backup, location_name: "Backup"))
+    ModifyBackupAttributesResponse.struct_class = Types::ModifyBackupAttributesResponse
+
+    ModifyClusterRequest.add_member(:backup_retention_policy, Shapes::ShapeRef.new(shape: BackupRetentionPolicy, required: true, location_name: "BackupRetentionPolicy"))
+    ModifyClusterRequest.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, required: true, location_name: "ClusterId"))
+    ModifyClusterRequest.struct_class = Types::ModifyClusterRequest
+
+    ModifyClusterResponse.add_member(:cluster, Shapes::ShapeRef.new(shape: Cluster, location_name: "Cluster"))
+    ModifyClusterResponse.struct_class = Types::ModifyClusterResponse
+
     RestoreBackupRequest.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
     RestoreBackupRequest.struct_class = Types::RestoreBackupRequest
 
@@ -456,6 +486,32 @@ module Aws::CloudHSMV2
         )
       end)
 
+      api.add_operation(:modify_backup_attributes, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ModifyBackupAttributes"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ModifyBackupAttributesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ModifyBackupAttributesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
+      end)
+
+      api.add_operation(:modify_cluster, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ModifyCluster"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ModifyClusterRequest)
+        o.output = Shapes::ShapeRef.new(shape: ModifyClusterResponse)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
+      end)
+
       api.add_operation(:restore_backup, Seahorse::Model::Operation.new.tap do |o|
         o.name = "RestoreBackup"
         o.http_method = "POST"

data/lib/aws-sdk-cloudhsmv2/types.rb

@@ -11,11 +11,12 @@ module Aws::CloudHSMV2
   module Types
 
     # Contains information about a backup of an AWS CloudHSM cluster. All
-    # backup objects contain the BackupId, BackupState, ClusterId, and
-    # CreateTimestamp parameters. Backups that were copied into a
-    # destination region additionally contain the CopyTimestamp,
-    # SourceBackup, SourceCluster, and SourceRegion paramters. A backup that
-    # is pending deletion will include the DeleteTimestamp parameter.
+    # backup objects contain the `BackupId`, `BackupState`, `ClusterId`, and
+    # `CreateTimestamp` parameters. Backups that were copied into a
+    # destination region additionally contain the `CopyTimestamp`,
+    # `SourceBackup`, `SourceCluster`, and `SourceRegion` parameters. A
+    # backup that is pending deletion will include the `DeleteTimestamp`
+    # parameter.
     #
     # @!attribute [rw] backup_id
     #   The identifier (ID) of the backup.
@@ -37,6 +38,13 @@ module Aws::CloudHSMV2
     #   The date and time when the backup was copied from a source backup.
     #   @return [Time]
     #
+    # @!attribute [rw] never_expires
+    #   Specifies whether the service should exempt a backup from the
+    #   retention policy for the cluster. `True` exempts a backup from the
+    #   retention policy. `False` means the service applies the backup
+    #   retention policy defined at the cluster.
+    #   @return [Boolean]
+    #
     # @!attribute [rw] source_region
     #   The AWS Region that contains the source backup from which the new
     #   backup was copied.
@@ -68,6 +76,7 @@ module Aws::CloudHSMV2
       :cluster_id,
       :create_timestamp,
       :copy_timestamp,
+      :never_expires,
       :source_region,
       :source_backup,
       :source_cluster,
@@ -77,6 +86,34 @@ module Aws::CloudHSMV2
       include Aws::Structure
     end
 
+    # A policy that defines the number of days to retain backups.
+    #
+    # @note When making an API call, you may pass BackupRetentionPolicy
+    #   data as a hash:
+    #
+    #       {
+    #         type: "DAYS", # accepts DAYS
+    #         value: "BackupRetentionValue",
+    #       }
+    #
+    # @!attribute [rw] type
+    #   The type of backup retention policy. For the `DAYS` type, the value
+    #   is the number of days to retain backups.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   Use a value between 7 - 379.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/BackupRetentionPolicy AWS API Documentation
+    #
+    class BackupRetentionPolicy < Struct.new(
+      :type,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains one or more certificates or a certificate signing request
     # (CSR).
     #
@@ -203,6 +240,10 @@ module Aws::CloudHSMV2
     #   The cluster's backup policy.
     #   @return [String]
     #
+    # @!attribute [rw] backup_retention_policy
+    #   A policy that defines how the service retains backups.
+    #   @return [Types::BackupRetentionPolicy]
+    #
     # @!attribute [rw] cluster_id
     #   The cluster's identifier (ID).
     #   @return [String]
@@ -264,6 +305,7 @@ module Aws::CloudHSMV2
     #
     class Cluster < Struct.new(
       :backup_policy,
+      :backup_retention_policy,
       :cluster_id,
       :create_timestamp,
       :hsms,
@@ -344,9 +386,13 @@ module Aws::CloudHSMV2
     #   data as a hash:
     #
     #       {
-    #         subnet_ids: ["SubnetId"], # required
+    #         backup_retention_policy: {
+    #           type: "DAYS", # accepts DAYS
+    #           value: "BackupRetentionValue",
+    #         },
     #         hsm_type: "HsmType", # required
     #         source_backup_id: "BackupId",
+    #         subnet_ids: ["SubnetId"], # required
     #         tag_list: [
     #           {
     #             key: "TagKey", # required
@@ -355,15 +401,9 @@ module Aws::CloudHSMV2
     #         ],
     #       }
     #
-    # @!attribute [rw] subnet_ids
-    #   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.
-    #   @return [Array<String>]
+    # @!attribute [rw] backup_retention_policy
+    #   A policy that defines how the service retains backups.
+    #   @return [Types::BackupRetentionPolicy]
     #
     # @!attribute [rw] hsm_type
     #   The type of HSM to use in the cluster. Currently the only allowed
@@ -376,6 +416,16 @@ module Aws::CloudHSMV2
     #   cluster. To find the backup ID, use DescribeBackups.
     #   @return [String]
     #
+    # @!attribute [rw] subnet_ids
+    #   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.
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] tag_list
     #   Tags to apply to the CloudHSM cluster during creation.
     #   @return [Array<Types::Tag>]
@@ -383,9 +433,10 @@ module Aws::CloudHSMV2
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterRequest AWS API Documentation
     #
     class CreateClusterRequest < Struct.new(
-      :subnet_ids,
+      :backup_retention_policy,
       :hsm_type,
       :source_backup_id,
+      :subnet_ids,
       :tag_list)
       SENSITIVE = []
       include Aws::Structure
@@ -606,6 +657,11 @@ module Aws::CloudHSMV2
     #
     #   Use the `states` filter to return only backups that match the
     #   specified state.
+    #
+    #   Use the `neverExpires` filter to return backups filtered by the
+    #   value in the `neverExpires` parameter. `True` returns all backups
+    #   exempt from the backup retention policy. `False` returns all backups
+    #   with a backup retention policy defined at the cluster.
     #   @return [Hash<String,Array<String>>]
     #
     # @!attribute [rw] sort_ascending
@@ -901,6 +957,94 @@ module Aws::CloudHSMV2
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ModifyBackupAttributesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         backup_id: "BackupId", # required
+    #         never_expires: false, # required
+    #       }
+    #
+    # @!attribute [rw] backup_id
+    #   The identifier (ID) of the backup to modify. To find the ID of a
+    #   backup, use the DescribeBackups operation.
+    #   @return [String]
+    #
+    # @!attribute [rw] never_expires
+    #   Specifies whether the service should exempt a backup from the
+    #   retention policy for the cluster. `True` exempts a backup from the
+    #   retention policy. `False` means the service applies the backup
+    #   retention policy defined at the cluster.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyBackupAttributesRequest AWS API Documentation
+    #
+    class ModifyBackupAttributesRequest < Struct.new(
+      :backup_id,
+      :never_expires)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] backup
+    #   Contains information about a backup of an AWS CloudHSM cluster. All
+    #   backup objects contain the `BackupId`, `BackupState`, `ClusterId`,
+    #   and `CreateTimestamp` parameters. Backups that were copied into a
+    #   destination region additionally contain the `CopyTimestamp`,
+    #   `SourceBackup`, `SourceCluster`, and `SourceRegion` parameters. A
+    #   backup that is pending deletion will include the `DeleteTimestamp`
+    #   parameter.
+    #   @return [Types::Backup]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyBackupAttributesResponse AWS API Documentation
+    #
+    class ModifyBackupAttributesResponse < Struct.new(
+      :backup)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ModifyClusterRequest
+    #   data as a hash:
+    #
+    #       {
+    #         backup_retention_policy: { # required
+    #           type: "DAYS", # accepts DAYS
+    #           value: "BackupRetentionValue",
+    #         },
+    #         cluster_id: "ClusterId", # required
+    #       }
+    #
+    # @!attribute [rw] backup_retention_policy
+    #   A policy that defines how the service retains backups.
+    #   @return [Types::BackupRetentionPolicy]
+    #
+    # @!attribute [rw] cluster_id
+    #   The identifier (ID) of the cluster that you want to modify. To find
+    #   the cluster ID, use DescribeClusters.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyClusterRequest AWS API Documentation
+    #
+    class ModifyClusterRequest < Struct.new(
+      :backup_retention_policy,
+      :cluster_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] cluster
+    #   Contains information about an AWS CloudHSM cluster.
+    #   @return [Types::Cluster]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyClusterResponse AWS API Documentation
+    #
+    class ModifyClusterResponse < Struct.new(
+      :cluster)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass RestoreBackupRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudhsmv2
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core