associate-source-network-stack¶

Description¶

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

Synopsis¶

  associate-source-network-stack
--cfn-stack-name <value>
--source-network-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--cfn-stack-name (string) [required]

CloudFormation template to associate with a Source Network.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

--source-network-id (string) [required]

The Source Network ID to associate with CloudFormation template.

Constraints:

min: 20

max: 20

pattern: ^sn-[0-9a-zA-Z]{17}$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

job -> (structure)

The Source Network association Job.

arn -> (string)

The ARN of a Job.

Constraints:

min: 20

max: 2048

pattern: ^arn:.{16,2044}$

creationDateTime -> (string)

The date and time of when the Job was created.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

endDateTime -> (string)

The date and time of when the Job ended.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

initiatedBy -> (string)

A string representing who initiated the Job.

Possible values:

START_RECOVERY

START_DRILL

FAILBACK

DIAGNOSTIC

TERMINATE_RECOVERY_INSTANCES

TARGET_ACCOUNT

CREATE_NETWORK_RECOVERY

UPDATE_NETWORK_RECOVERY

ASSOCIATE_NETWORK_RECOVERY

jobID -> (string) [required]

The ID of the Job.

Constraints:

min: 24

max: 24

pattern: ^drsjob-[0-9a-zA-Z]{17}$

participatingResources -> (list)

A list of resources that the Job is acting upon.

(structure)

Represents a resource participating in an asynchronous Job.

launchStatus -> (string)

The launch status of a participating resource.

Possible values:

PENDING

IN_PROGRESS

LAUNCHED

FAILED

TERMINATED

participatingResourceID -> (tagged union structure)

The ID of a participating resource.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: sourceNetworkID.

sourceNetworkID -> (string)

Source Network ID.

Constraints:

min: 20

max: 20

pattern: ^sn-[0-9a-zA-Z]{17}$

participatingServers -> (list)

A list of servers that the Job is acting upon.

(structure)

Represents a server participating in an asynchronous Job.

launchActionsStatus -> (structure)

The post-launch action runs of a participating server.

runs -> (list)

List of post launch action status.

(structure)

Launch action run.

action -> (structure)

Action.

actionCode -> (string)

Launch action code.

Constraints:

min: 1

max: 1011

pattern: ^([A-Za-z0-9-/:])+$

actionId -> (string)

Launch action Id.

Constraints:

min: 1

max: 64

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

actionVersion -> (string)

Launch action version.

Constraints:

min: 1

max: 10

pattern: ^(\$DEFAULT|\$LATEST|[0-9]+)$

active -> (boolean)

Whether the launch action is active.

category -> (string)

Launch action category.

Possible values:

MONITORING

VALIDATION

CONFIGURATION

SECURITY

OTHER

description -> (string)

Launch action description.

Constraints:

min: 0

max: 1024

pattern: ^[0-9a-zA-Z ():/.,'-_#*; ]*$

name -> (string)

Launch action name.

Constraints:

min: 1

max: 256

pattern: ^[A-Za-z0-9][A-Za-z0-9 /_-]*$

optional -> (boolean)

Whether the launch will not be marked as failed if this action fails.

order -> (integer)

Launch action order.

Constraints:

min: 2

max: 10000

parameters -> (map)

Launch action parameters.

Constraints:

min: 0

max: 20

key -> (string)

Constraints:

min: 1

max: 1011

pattern: ^([A-Za-z0-9])+$

value -> (structure)

Launch action parameter.

type -> (string)

Type.

Possible values:

SSM_STORE

DYNAMIC

value -> (string)

Value.

Constraints:

min: 1

max: 1011

pattern: ^[A-Za-z0-9.-]+$

type -> (string)

Launch action type.

Possible values:

SSM_AUTOMATION

SSM_COMMAND

failureReason -> (string)

Failure reason.

Constraints:

min: 0

max: 256

pattern: ^[0-9a-zA-Z ():/.,'-_#*;]*$

runId -> (string)

Run Id.

Constraints:

min: 1

max: 64

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status -> (string)

Run status.

Possible values:

IN_PROGRESS

SUCCEEDED

FAILED

ssmAgentDiscoveryDatetime -> (string)

Time where the AWS Systems Manager was detected as running on the launched instance.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

launchStatus -> (string)

The launch status of a participating server.

Possible values:

PENDING

IN_PROGRESS

LAUNCHED

FAILED

TERMINATED

recoveryInstanceID -> (string)

The Recovery Instance ID of a participating server.

Constraints:

min: 10

max: 19

pattern: ^i-[0-9a-fA-F]{8,}$

sourceServerID -> (string)

The Source Server ID of a participating server.

Constraints:

min: 19

max: 19

pattern: ^s-[0-9a-zA-Z]{17}$

status -> (string)

The status of the Job.

Possible values:

PENDING

STARTED

COMPLETED

tags -> (map)

A list of tags associated with the Job.

key -> (string)

Constraints:

min: 0

max: 256

value -> (string)

Constraints:

min: 0

max: 256

type -> (string)

The type of the Job.

Possible values:

LAUNCH

TERMINATE

CREATE_CONVERTED_SNAPSHOT

Table of Contents

Feedback

User Guide