{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cloudhsmv2#Backup": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the backup.

", "smithy.api#required": {} } }, "BackupArn": { "target": "com.amazonaws.cloudhsmv2#BackupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup.

" } }, "BackupState": { "target": "com.amazonaws.cloudhsmv2#BackupState", "traits": { "smithy.api#documentation": "

The state of the backup.

" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the cluster that was backed up.

" } }, "CreateTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the backup was created.

" } }, "CopyTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the backup was copied from a source backup.

" } }, "NeverExpires": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "SourceRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { "smithy.api#documentation": "

The AWS Region that contains the source backup from which the new backup was\n copied.

" } }, "SourceBackup": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the source backup from which the new backup was\n copied.

" } }, "SourceCluster": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the cluster containing the source backup from which the new\n backup was copied.

" } }, "DeleteTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the backup will be permanently deleted.

" } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

The list of tags for the backup.

" } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "

The HSM type used to create the backup.

" } }, "Mode": { "target": "com.amazonaws.cloudhsmv2#ClusterMode", "traits": { "smithy.api#documentation": "

The mode of the cluster that was backed up.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a backup of an CloudHSM cluster. All backup objects\n contain the BackupId, BackupState, ClusterId, and\n CreateTimestamp parameters. Backups that were copied into a destination region\n additionally contain the CopyTimestamp, SourceBackup,\n SourceCluster, and SourceRegion parameters. A backup that is\n pending deletion will include the DeleteTimestamp parameter.

" } }, "com.amazonaws.cloudhsmv2#BackupArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:backup/)?backup-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#BackupId": { "type": "string", "traits": { "smithy.api#pattern": "^backup-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#BackupPolicy": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } } } }, "com.amazonaws.cloudhsmv2#BackupRetentionPolicy": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionType", "traits": { "smithy.api#documentation": "

The type of backup retention policy. For the DAYS type, the value is \n the number of days to retain backups.

" } }, "Value": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionValue", "traits": { "smithy.api#documentation": "

Use a value between 7 - 379.

" } } }, "traits": { "smithy.api#documentation": "

A policy that defines the number of days to retain backups.

" } }, "com.amazonaws.cloudhsmv2#BackupRetentionType": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } } } }, "com.amazonaws.cloudhsmv2#BackupRetentionValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 3 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.cloudhsmv2#BackupState": { "type": "enum", "members": { "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "READY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READY" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "PENDING_DELETION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETION" } } } }, "com.amazonaws.cloudhsmv2#Backups": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Backup" } }, "com.amazonaws.cloudhsmv2#BackupsMaxSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#BaldrApiService": { "type": "service", "version": "2017-04-28", "operations": [ { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegion" }, { "target": "com.amazonaws.cloudhsmv2#CreateCluster" }, { "target": "com.amazonaws.cloudhsmv2#CreateHsm" }, { "target": "com.amazonaws.cloudhsmv2#DeleteBackup" }, { "target": "com.amazonaws.cloudhsmv2#DeleteCluster" }, { "target": "com.amazonaws.cloudhsmv2#DeleteHsm" }, { "target": "com.amazonaws.cloudhsmv2#DeleteResourcePolicy" }, { "target": "com.amazonaws.cloudhsmv2#DescribeBackups" }, { "target": "com.amazonaws.cloudhsmv2#DescribeClusters" }, { "target": "com.amazonaws.cloudhsmv2#GetResourcePolicy" }, { "target": "com.amazonaws.cloudhsmv2#InitializeCluster" }, { "target": "com.amazonaws.cloudhsmv2#ListTags" }, { "target": "com.amazonaws.cloudhsmv2#ModifyBackupAttributes" }, { "target": "com.amazonaws.cloudhsmv2#ModifyCluster" }, { "target": "com.amazonaws.cloudhsmv2#PutResourcePolicy" }, { "target": "com.amazonaws.cloudhsmv2#RestoreBackup" }, { "target": "com.amazonaws.cloudhsmv2#TagResource" }, { "target": "com.amazonaws.cloudhsmv2#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "CloudHSM V2", "arnNamespace": "cloudhsm", "cloudFormationName": "CloudHSMV2", "cloudTrailEventSource": "cloudhsmv2.amazonaws.com", "docId": "cloudhsmv2-2017-04-28", "endpointPrefix": "cloudhsmv2" }, "aws.auth#sigv4": { "name": "cloudhsm" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

For more information about CloudHSM, see CloudHSM and the \n CloudHSM User Guide.

", "smithy.api#title": "AWS CloudHSM V2", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 15, "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAoAAAAGAAAABAAAAAkAAAAHAAAABwX14QoAAAAIAAAACAX14QoF9eELAAAABQX14QgF9eEJAAAABAAAAAwAAAALAAAABgX14QYF9eEHAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudhsmv2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudhsmv2-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cloudhsmv2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://cloudhsmv2.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://cloudhsmv2.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cloudhsmv2.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cloudhsmv2.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.cloudhsmv2#Boolean": { "type": "boolean" }, "com.amazonaws.cloudhsmv2#Cert": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 20000 }, "smithy.api#pattern": "^[a-zA-Z0-9+-/=\\s]*$" } }, "com.amazonaws.cloudhsmv2#Certificates": { "type": "structure", "members": { "ClusterCsr": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's\n state is UNINITIALIZED.

" } }, "HsmCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The HSM certificate issued (signed) by the HSM hardware.

" } }, "AwsHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The HSM hardware certificate issued (signed) by CloudHSM.

" } }, "ManufacturerHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The HSM hardware certificate issued (signed) by the hardware manufacturer.

" } }, "ClusterCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The cluster certificate issued (signed) by the issuing certificate authority (CA) of\n the cluster's owner.

" } } }, "traits": { "smithy.api#documentation": "

Contains one or more certificates or a certificate signing request (CSR).

" } }, "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because the requester does not have permission to perform the\n requested operation.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:(backup/backup|cluster/cluster|hsm/hsm)-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because of an CloudHSM internal failure. The request can\n be retried.

", "smithy.api#error": "server" } }, "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because it is not a valid request.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmResourceLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because it exceeds an CloudHSM limit.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because it refers to a resource that cannot be\n found.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because an error occurred.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmTagException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#Cluster": { "type": "structure", "members": { "BackupPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupPolicy", "traits": { "smithy.api#documentation": "

The cluster's backup policy.

" } }, "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "

A policy that defines how the service retains backups.

" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

The cluster's identifier (ID).

" } }, "CreateTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the cluster was created.

" } }, "Hsms": { "target": "com.amazonaws.cloudhsmv2#Hsms", "traits": { "smithy.api#documentation": "

Contains information about the HSMs in the cluster.

" } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "

The type of HSM that the cluster contains.

" } }, "HsmTypeRollbackExpiration": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp until when the cluster can be rolled back to its original HSM type.

" } }, "PreCoPassword": { "target": "com.amazonaws.cloudhsmv2#PreCoPassword", "traits": { "smithy.api#documentation": "

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

" } }, "SecurityGroup": { "target": "com.amazonaws.cloudhsmv2#SecurityGroup", "traits": { "smithy.api#documentation": "

The identifier (ID) of the cluster's security group.

" } }, "SourceBackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the backup used to create the cluster. This value exists only\n when the cluster was created from a backup.

" } }, "State": { "target": "com.amazonaws.cloudhsmv2#ClusterState", "traits": { "smithy.api#documentation": "

The cluster's state.

" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#StateMessage", "traits": { "smithy.api#documentation": "

A description of the cluster's state.

" } }, "SubnetMapping": { "target": "com.amazonaws.cloudhsmv2#ExternalSubnetMapping", "traits": { "smithy.api#documentation": "

A map from availability zone to the cluster\u2019s subnet in that availability zone.

" } }, "VpcId": { "target": "com.amazonaws.cloudhsmv2#VpcId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the virtual private cloud (VPC) that contains the\n cluster.

" } }, "NetworkType": { "target": "com.amazonaws.cloudhsmv2#NetworkType", "traits": { "smithy.api#documentation": "

The cluster's NetworkType can be IPv4 (the default) or DUALSTACK.\n The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols.\n To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6.\n This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets.\n The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

" } }, "Certificates": { "target": "com.amazonaws.cloudhsmv2#Certificates", "traits": { "smithy.api#documentation": "

Contains one or more certificates or a certificate signing request (CSR).

" } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

The list of tags for the cluster.

" } }, "Mode": { "target": "com.amazonaws.cloudhsmv2#ClusterMode", "traits": { "smithy.api#documentation": "

The mode of the cluster.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an CloudHSM cluster.

" } }, "com.amazonaws.cloudhsmv2#ClusterId": { "type": "string", "traits": { "smithy.api#pattern": "^cluster-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#ClusterMode": { "type": "enum", "members": { "FIPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIPS" } }, "NON_FIPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_FIPS" } } } }, "com.amazonaws.cloudhsmv2#ClusterState": { "type": "enum", "members": { "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "UNINITIALIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNINITIALIZED" } }, "INITIALIZE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INITIALIZE_IN_PROGRESS" } }, "INITIALIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INITIALIZED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, "MODIFY_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODIFY_IN_PROGRESS" } }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "DEGRADED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEGRADED" } } } }, "com.amazonaws.cloudhsmv2#Clusters": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Cluster" } }, "com.amazonaws.cloudhsmv2#ClustersMaxSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegion": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegionResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

Copy an CloudHSM cluster backup to a different region.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest": { "type": "structure", "members": { "DestinationRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegionResponse": { "type": "structure", "members": { "DestinationBackup": { "target": "com.amazonaws.cloudhsmv2#DestinationBackup", "traits": { "smithy.api#documentation": "

Information on the backup that will be copied to the destination region, including\n CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the\n destination backup will be the same as that of the source backup.

\n

You will need to use the sourceBackupID returned in this operation to use\n the DescribeBackups operation on the backup that will be copied to the\n destination region.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#CreateCluster": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#CreateClusterRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#CreateClusterResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

Creates a new CloudHSM cluster.

\n

\n Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup \n ARN in the value of the SourceBackupId parameter.

" } }, "com.amazonaws.cloudhsmv2#CreateClusterRequest": { "type": "structure", "members": { "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "

A policy that defines how the service retains backups.

" } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "

The type of HSM to use in the cluster. The allowed values are\n hsm1.medium and hsm2m.medium.

", "smithy.api#required": {} } }, "SourceBackupId": { "target": "com.amazonaws.cloudhsmv2#BackupArn", "traits": { "smithy.api#documentation": "

The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.\n

" } }, "SubnetIds": { "target": "com.amazonaws.cloudhsmv2#SubnetIds", "traits": { "smithy.api#documentation": "

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

\n ", "smithy.api#required": {} } }, "NetworkType": { "target": "com.amazonaws.cloudhsmv2#NetworkType", "traits": { "smithy.api#documentation": "

The NetworkType to create a cluster with. The allowed values are\n IPV4 and DUALSTACK.\n

" } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

Tags to apply to the CloudHSM cluster during creation.

" } }, "Mode": { "target": "com.amazonaws.cloudhsmv2#ClusterMode", "traits": { "smithy.api#documentation": "

The mode to use in the cluster. The allowed values are\n FIPS and NON_FIPS.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#CreateClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster", "traits": { "smithy.api#documentation": "

Information about the cluster that was created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#CreateHsm": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#CreateHsmRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#CreateHsmResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.

" } }, "com.amazonaws.cloudhsmv2#CreateHsmRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "AvailabilityZone": { "target": "com.amazonaws.cloudhsmv2#ExternalAz", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "IpAddress": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#CreateHsmResponse": { "type": "structure", "members": { "Hsm": { "target": "com.amazonaws.cloudhsmv2#Hsm", "traits": { "smithy.api#documentation": "

Information about the HSM that was created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DeleteBackup": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteBackupRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteBackupResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#DeleteBackupRequest": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DeleteBackupResponse": { "type": "structure", "members": { "Backup": { "target": "com.amazonaws.cloudhsmv2#Backup", "traits": { "smithy.api#documentation": "

Information on the Backup object deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DeleteCluster": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteClusterRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteClusterResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#DeleteClusterRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DeleteClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster", "traits": { "smithy.api#documentation": "

Information about the cluster that was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DeleteHsm": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteHsmRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteHsmResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#DeleteHsmRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "

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

" } }, "EniId": { "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { "smithy.api#documentation": "

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

" } }, "EniIp": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DeleteHsmResponse": { "type": "structure", "members": { "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the HSM that was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from\n any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that \n backup.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#DeleteResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource from which the policy will be removed.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DeleteResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource from which the policy was deleted.

" } }, "Policy": { "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", "traits": { "smithy.api#documentation": "

The policy previously attached to the resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DescribeBackups": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DescribeBackupsRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DescribeBackupsResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

\n

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

\n

\n Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudhsmv2#DescribeBackupsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.cloudhsmv2#BackupsMaxSize", "traits": { "smithy.api#documentation": "

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

" } }, "Filters": { "target": "com.amazonaws.cloudhsmv2#Filters", "traits": { "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

Use the states filter to return only backups that match the specified\n state.

\n

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

" } }, "Shared": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "

Describe backups that are shared with you.

\n \n

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager \n resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a \n standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation.\n\n For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

\n
" } }, "SortAscending": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DescribeBackupsResponse": { "type": "structure", "members": { "Backups": { "target": "com.amazonaws.cloudhsmv2#Backups", "traits": { "smithy.api#documentation": "

A list of backups.

" } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

An opaque string that indicates that the response contains only a subset of backups.\n Use this value in a subsequent DescribeBackups request to get more\n backups.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DescribeClusters": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DescribeClustersRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DescribeClustersResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

Gets information about CloudHSM clusters.

\n

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

\n

\n Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.test#smokeTests": [ { "id": "DescribeClustersSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.cloudhsmv2#DescribeClustersRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.cloudhsmv2#Filters", "traits": { "smithy.api#documentation": "

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

\n

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

\n

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

\n

Use the states filter to return only clusters that match the specified\n state.

" } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.cloudhsmv2#ClustersMaxSize", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#DescribeClustersResponse": { "type": "structure", "members": { "Clusters": { "target": "com.amazonaws.cloudhsmv2#Clusters", "traits": { "smithy.api#documentation": "

A list of clusters.

" } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

An opaque string that indicates that the response contains only a subset of clusters.\n Use this value in a subsequent DescribeClusters request to get more\n clusters.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#DestinationBackup": { "type": "structure", "members": { "CreateTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when both the source backup was created.

" } }, "SourceRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { "smithy.api#documentation": "

The AWS region that contains the source backup from which the new backup was copied.

" } }, "SourceBackup": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the source backup from which the new backup was copied.

" } }, "SourceCluster": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.

" } }, "com.amazonaws.cloudhsmv2#EniId": { "type": "string", "traits": { "smithy.api#pattern": "^eni-[0-9a-fA-F]{8,17}$" } }, "com.amazonaws.cloudhsmv2#ExternalAz": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]$" } }, "com.amazonaws.cloudhsmv2#ExternalSubnetMapping": { "type": "map", "key": { "target": "com.amazonaws.cloudhsmv2#ExternalAz" }, "value": { "target": "com.amazonaws.cloudhsmv2#SubnetId" } }, "com.amazonaws.cloudhsmv2#Field": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, "com.amazonaws.cloudhsmv2#Filters": { "type": "map", "key": { "target": "com.amazonaws.cloudhsmv2#Field" }, "value": { "target": "com.amazonaws.cloudhsmv2#Strings" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 } } }, "com.amazonaws.cloudhsmv2#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource policy document attached to a given resource.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#GetResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource to which a policy is attached.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#GetResourcePolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", "traits": { "smithy.api#documentation": "

The policy attached to a resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#Hsm": { "type": "structure", "members": { "AvailabilityZone": { "target": "com.amazonaws.cloudhsmv2#ExternalAz", "traits": { "smithy.api#documentation": "

The Availability Zone that contains the HSM.

" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

" } }, "SubnetId": { "target": "com.amazonaws.cloudhsmv2#SubnetId", "traits": { "smithy.api#documentation": "

The subnet that contains the HSM's elastic network interface (ENI).

" } }, "EniId": { "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the HSM's elastic network interface (ENI).

" } }, "EniIp": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "

The IP address of the HSM's elastic network interface (ENI).

" } }, "EniIpV6": { "target": "com.amazonaws.cloudhsmv2#IpV6Address", "traits": { "smithy.api#documentation": "

The IPv6 address (if any) of the HSM's elastic network interface (ENI).

" } }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "

The HSM's identifier (ID).

", "smithy.api#required": {} } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "

The type of HSM.

" } }, "State": { "target": "com.amazonaws.cloudhsmv2#HsmState", "traits": { "smithy.api#documentation": "

The HSM's state.

" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#String", "traits": { "smithy.api#documentation": "

A description of the HSM's state.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a hardware security module (HSM) in an CloudHSM\n cluster.

" } }, "com.amazonaws.cloudhsmv2#HsmId": { "type": "string", "traits": { "smithy.api#pattern": "^hsm-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#HsmState": { "type": "enum", "members": { "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DEGRADED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEGRADED" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.cloudhsmv2#HsmType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 }, "smithy.api#pattern": "^((p|)hsm[0-9][a-z.]*\\.[a-zA-Z]+)$" } }, "com.amazonaws.cloudhsmv2#Hsms": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Hsm" } }, "com.amazonaws.cloudhsmv2#InitializeCluster": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#InitializeClusterRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#InitializeClusterResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#InitializeClusterRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "SignedCert": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "TrustAnchor": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The issuing certificate of the issuing certificate authority (CA) that issued (signed)\n 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\n root certificate. The certificate must be in PEM format and can contain a\n maximum of 5000 characters.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#InitializeClusterResponse": { "type": "structure", "members": { "State": { "target": "com.amazonaws.cloudhsmv2#ClusterState", "traits": { "smithy.api#documentation": "

The cluster's state.

" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#StateMessage", "traits": { "smithy.api#documentation": "

A description of the cluster's state.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#IpAddress": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$" } }, "com.amazonaws.cloudhsmv2#IpV6Address": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.cloudhsmv2#ListTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#ListTagsRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#ListTagsResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

Gets a list of tags for the specified CloudHSM cluster.

\n

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudhsmv2#ListTagsRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.cloudhsmv2#MaxSize", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#ListTagsResponse": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

A list of tags.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "

An opaque string that indicates that the response contains only a subset of tags. Use\n this value in a subsequent ListTags request to get more tags.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#MaxSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudhsmv2#ModifyBackupAttributes": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#ModifyBackupAttributesRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#ModifyBackupAttributesResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Modifies attributes for CloudHSM backup.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#ModifyBackupAttributesRequest": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "NeverExpires": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#ModifyBackupAttributesResponse": { "type": "structure", "members": { "Backup": { "target": "com.amazonaws.cloudhsmv2#Backup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#ModifyCluster": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#ModifyClusterRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#ModifyClusterResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Modifies CloudHSM cluster.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#ModifyClusterRequest": { "type": "structure", "members": { "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "

The desired HSM type of the cluster.

" } }, "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "

A policy that defines how the service retains backups.

" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#ModifyClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#NetworkType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPV4" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUALSTACK" } } } }, "com.amazonaws.cloudhsmv2#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudhsmv2#PreCoPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 32 } } }, "com.amazonaws.cloudhsmv2#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity \n (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support \n CloudHSM resource policies:

\n \n

In order to share a backup, it must be in a 'READY' state and you must own it.

\n \n

While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager\n (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at\n one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to\n describe the backups you share with them, you must promote the backup to a standard RAM\n Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.\n\n For more information, see Working with shared backups in the CloudHSM User Guide

\n
\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#PutResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

" } }, "Policy": { "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", "traits": { "smithy.api#documentation": "

The policy you want to associate with a resource.

\n

For an example policy, see Working with shared backups in the CloudHSM User Guide

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#PutResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource to which a policy is attached.

" } }, "Policy": { "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", "traits": { "smithy.api#documentation": "

The policy attached to a resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#Region": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d$" } }, "com.amazonaws.cloudhsmv2#ResourceId": { "type": "string", "traits": { "smithy.api#pattern": "^(?:cluster|backup)-[2-7a-zA-Z]{11,16}$" } }, "com.amazonaws.cloudhsmv2#ResourcePolicy": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20000 } } }, "com.amazonaws.cloudhsmv2#RestoreBackup": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#RestoreBackupRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#RestoreBackupResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "

Restores a specified CloudHSM backup that is in the\n PENDING_DELETION state. For more information on deleting a backup, see\n DeleteBackup.

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#RestoreBackupRequest": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#RestoreBackupResponse": { "type": "structure", "members": { "Backup": { "target": "com.amazonaws.cloudhsmv2#Backup", "traits": { "smithy.api#documentation": "

Information on the Backup object created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#SecurityGroup": { "type": "string", "traits": { "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,17}$" } }, "com.amazonaws.cloudhsmv2#StateMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 300 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudhsmv2#String": { "type": "string" }, "com.amazonaws.cloudhsmv2#Strings": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#String" } }, "com.amazonaws.cloudhsmv2#SubnetId": { "type": "string", "traits": { "smithy.api#pattern": "^subnet-[0-9a-fA-F]{8,17}$" } }, "com.amazonaws.cloudhsmv2#SubnetIds": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#SubnetId" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.cloudhsmv2#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.cloudhsmv2#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudhsmv2#TagValue", "traits": { "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a tag. A tag is a key-value pair.

" } }, "com.amazonaws.cloudhsmv2#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.cloudhsmv2#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#TagList": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#TagResourceRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceLimitExceededException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#TagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

A list of one or more tags.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.cloudhsmv2#Timestamp": { "type": "timestamp" }, "com.amazonaws.cloudhsmv2#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#UntagResourceRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "

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

\n

\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

" } }, "com.amazonaws.cloudhsmv2#UntagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "TagKeyList": { "target": "com.amazonaws.cloudhsmv2#TagKeyList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cloudhsmv2#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cloudhsmv2#VpcId": { "type": "string", "traits": { "smithy.api#pattern": "^vpc-[0-9a-fA-F]$" } }, "com.amazonaws.cloudhsmv2#errorMessage": { "type": "string" } } }