Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . resiliencehub ]

add-draft-app-version-resource-mappings

Description

Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources suported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.

See also: AWS API Documentation

Synopsis

  add-draft-app-version-resource-mappings
--app-arn <value>
--resource-mappings <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--app-arn (string)

Amazon Resource Name (ARN) of the Resilience Hub 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 Amazon Web Services General Reference guide.

--resource-mappings (list)

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.

(structure)

Defines a resource mapping.

appRegistryAppName -> (string)

The name of the application this resource is mapped to.

eksSourceName -> (string)

Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

Note

This parameter accepts values in "eks-cluster/namespace" format.

logicalStackName -> (string)

The name of the CloudFormation stack this resource is mapped to.

mappingType -> (string)

Specifies the type of resource mapping.

AppRegistryApp

The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

CfnStack

The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

Resource

The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

ResourceGroup

The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.

physicalResourceId -> (structure)

Identifier of the physical resource.

awsAccountId -> (string)

The Amazon Web Services account that owns the physical resource.

awsRegion -> (string)

The Amazon Web Services Region that the physical resource is located in.

identifier -> (string)

Identifier of the physical resource.

type -> (string)

Specifies the type of physical resource identifier.

Arn

The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

• AWS::ECS::Service

• AWS::EFS::FileSystem

• AWS::ElasticLoadBalancingV2::LoadBalancer

• AWS::Lambda::Function

• AWS::SNS::Topic

  Native

The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

• AWS::ApiGateway::RestApi
• AWS::ApiGatewayV2::Api
• AWS::AutoScaling::AutoScalingGroup
• AWS::DocDB::DBCluster
• AWS::DocDB::DBGlobalCluster
• AWS::DocDB::DBInstance
• AWS::DynamoDB::GlobalTable
• AWS::DynamoDB::Table
• AWS::EC2::EC2Fleet
• AWS::EC2::Instance
• AWS::EC2::NatGateway
• AWS::EC2::Volume
• AWS::ElasticLoadBalancing::LoadBalancer
• AWS::RDS::DBCluster
• AWS::RDS::DBInstance
• AWS::RDS::GlobalCluster
• AWS::Route53::RecordSet
• AWS::S3::Bucket
• AWS::SQS::Queue

resourceGroupName -> (string)

Name of the resource group that the resource is mapped to.

resourceName -> (string)

Name of the resource that the resource is mapped to.

terraformSourceName -> (string)

The short name of the Terraform source.

Shorthand Syntax:

appRegistryAppName=string,eksSourceName=string,logicalStackName=string,mappingType=string,physicalResourceId={awsAccountId=string,awsRegion=string,identifier=string,type=string},resourceGroupName=string,resourceName=string,terraformSourceName=string ...

JSON Syntax:

[
  {
    "appRegistryAppName": "string",
    "eksSourceName": "string",
    "logicalStackName": "string",
    "mappingType": "CfnStack"|"Resource"|"AppRegistryApp"|"ResourceGroup"|"Terraform"|"EKS",
    "physicalResourceId": {
      "awsAccountId": "string",
      "awsRegion": "string",
      "identifier": "string",
      "type": "Arn"|"Native"
    },
    "resourceGroupName": "string",
    "resourceName": "string",
    "terraformSourceName": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

appArn -> (string)

Amazon Resource Name (ARN) of the Resilience Hub 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 Amazon Web Services General Reference guide.

appVersion -> (string)

The version of the application.

resourceMappings -> (list)

List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.

(structure)

Defines a resource mapping.

appRegistryAppName -> (string)

The name of the application this resource is mapped to.

eksSourceName -> (string)

Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

Note

This parameter accepts values in "eks-cluster/namespace" format.

logicalStackName -> (string)

The name of the CloudFormation stack this resource is mapped to.

mappingType -> (string)

Specifies the type of resource mapping.

AppRegistryApp

The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

CfnStack

The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

Resource

The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

ResourceGroup

The resource is mapped to Resource Groups. The name of the resource group is contained in the resourceGroupName property.

physicalResourceId -> (structure)

Identifier of the physical resource.

awsAccountId -> (string)

The Amazon Web Services account that owns the physical resource.

awsRegion -> (string)

The Amazon Web Services Region that the physical resource is located in.

identifier -> (string)

Identifier of the physical resource.

type -> (string)

Specifies the type of physical resource identifier.

Arn

The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

• AWS::ECS::Service

• AWS::EFS::FileSystem

• AWS::ElasticLoadBalancingV2::LoadBalancer

• AWS::Lambda::Function

• AWS::SNS::Topic

  Native

The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

• AWS::ApiGateway::RestApi
• AWS::ApiGatewayV2::Api
• AWS::AutoScaling::AutoScalingGroup
• AWS::DocDB::DBCluster
• AWS::DocDB::DBGlobalCluster
• AWS::DocDB::DBInstance
• AWS::DynamoDB::GlobalTable
• AWS::DynamoDB::Table
• AWS::EC2::EC2Fleet
• AWS::EC2::Instance
• AWS::EC2::NatGateway
• AWS::EC2::Volume
• AWS::ElasticLoadBalancing::LoadBalancer
• AWS::RDS::DBCluster
• AWS::RDS::DBInstance
• AWS::RDS::GlobalCluster
• AWS::Route53::RecordSet
• AWS::S3::Bucket
• AWS::SQS::Queue

resourceGroupName -> (string)

Name of the resource group that the resource is mapped to.

resourceName -> (string)

Name of the resource that the resource is mapped to.

terraformSourceName -> (string)

The short name of the Terraform source.