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 ]

create-app-version-resource¶

Description¶

Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.

Note

This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID , you must call ResolveAppVersionResources API.

Synopsis¶

  create-app-version-resource
[--additional-info <value>]
--app-arn <value>
--app-components <value>
[--aws-account-id <value>]
[--aws-region <value>]
[--client-token <value>]
--logical-resource-id <value>
--physical-resource-id <value>
[--resource-name <value>]
--resource-type <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¶

--additional-info (map)

Currently, there is no supported additional information for resources.

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--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.

--app-components (list)

List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

(string)

Syntax:

"string" "string" ...

--aws-account-id (string)

Amazon Web Services account that owns the physical resource.

--aws-region (string)

Amazon Web Services region that owns the physical resource.

--client-token (string)

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

--logical-resource-id (structure)

Logical identifier of the resource.

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.

identifier -> (string)

Identifier of the resource.

logicalStackName -> (string)

The name of the CloudFormation stack this resource belongs to.

resourceGroupName -> (string)

The name of the resource group that this resource belongs to.

terraformSourceName -> (string)

The name of the Terraform S3 state file this resource belongs to.

Shorthand Syntax:

eksSourceName=string,identifier=string,logicalStackName=string,resourceGroupName=string,terraformSourceName=string

JSON Syntax:

{
  "eksSourceName": "string",
  "identifier": "string",
  "logicalStackName": "string",
  "resourceGroupName": "string",
  "terraformSourceName": "string"
}

--physical-resource-id (string)

Physical identifier of the resource.

--resource-name (string)

Name of the resource.

--resource-type (string)

Type of resource.

--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)

Resilience Hub application version.

physicalResource -> (structure)

Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

additionalInfo -> (map)

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters .

Note
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

key -> (string)

value -> (list)

(string)

appComponents -> (list)

The application components that belong to this resource.

(structure)

Defines an Application Component.

additionalInfo -> (map)

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters .

Note
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

key -> (string)

value -> (list)

(string)

id -> (string)

Identifier of the Application Component.

name -> (string)

Name of the Application Component.

type -> (string)

The type of Application Component.

excluded -> (boolean)

Indicates if a resource is included or excluded from the assessment.

logicalResourceId -> (structure)

Logical identifier of the resource.

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.

identifier -> (string)

Identifier of the resource.

logicalStackName -> (string)

The name of the CloudFormation stack this resource belongs to.

resourceGroupName -> (string)

The name of the resource group that this resource belongs to.

terraformSourceName -> (string)

The name of the Terraform S3 state file this resource belongs to.

parentResourceName -> (string)

Name of the parent resource.

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

resourceName -> (string)

The name of the resource.

resourceType -> (string)

The type of resource.

sourceType -> (string)

Type of input source.

Table Of Contents

Feedback

User Guide

Note:

create-app-version-resource¶

Description¶

Note

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note

Note

Note