AddDraftAppVersionResourceMappings - AWS Resilience Hub

AddDraftAppVersionResourceMappings

Adds the resource mapping for the draft application version.

Request Syntax

POST /add-draft-app-version-resource-mappings HTTP/1.1 Content-type: application/json { "appArn": "string", "resourceMappings": [ { "appRegistryAppName": "string", "logicalStackName": "string", "mappingType": "string", "physicalResourceId": { "awsAccountId": "string", "awsRegion": "string", "identifier": "string", "type": "string" }, "resourceGroupName": "string", "resourceName": "string", "terraformSourceName": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

appArn

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

resourceMappings

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

Type: Array of ResourceMapping objects

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "appArn": "string", "appVersion": "string", "resourceMappings": [ { "appRegistryAppName": "string", "logicalStackName": "string", "mappingType": "string", "physicalResourceId": { "awsAccountId": "string", "awsRegion": "string", "identifier": "string", "type": "string" }, "resourceGroupName": "string", "resourceName": "string", "terraformSourceName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

appArn

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$

appVersion

The version of the application.

Type: String

Pattern: ^\S{1,50}$

resourceMappings

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

Type: Array of ResourceMapping objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

HTTP Status Code: 403

ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

InternalServerException

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

Examples

Example request

The following is an example request payload.

Sample Request

{ "appArn": "arn:aws:resiliencehub:us-west-2:444455556666:app/6159572d-e090-46d1-93b4-d28ece3a99f9", "resourceMappings": [ { "resourceName": null, "logicalResourceIdentifier": null, "logicalStackName": "AmsTestResourceStack", "mappingType": "CfnStack", "physicalResourceId": { "identifier": "arn:aws:cloudformation:us-west-2:444455556666:stack/AmsTestResourceStack/a1d33d80-3a37-11eb-91be-06cfd442e419", "type": "Arn", "awsRegion": null, "awsAccountId": null } } ] }

Example response

The following is an example response payload.

Sample Response

{ "appArn": "arn:aws:resiliencehub:us-west-2:444455556666:app/6159572d-e090-46d1-93b4-d28ece3a99f9", "appVersion": "draft", "resourceMappings": [ { "logicalStackName": "AmsTestResourceStack", "mappingType": "CfnStack", "physicalResourceId": { "identifier": "arn:aws:cloudformation:us-west-2:444455556666:stack/AmsTestResourceStack/a1d33d80-3a37-11eb-91be-06cfd442e419", "type": "Arn" } } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: