AWS CLI Command Reference

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

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.

See also: AWS API Documentation

Synopsis

  associate-source-network-stack
--cfn-stack-name <value>
--source-network-id <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

--cfn-stack-name (string)

CloudFormation template to associate with a Source Network.

--source-network-id (string)

The Source Network ID to associate with CloudFormation template.

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

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

job -> (structure)

The Source Network association Job.

arn -> (string)

The ARN of a Job.

creationDateTime -> (string)

The date and time of when the Job was created.

endDateTime -> (string)

The date and time of when the Job ended.

initiatedBy -> (string)

A string representing who initiated the Job.

jobID -> (string)

The ID of the Job.

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.

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.

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.

actionId -> (string)

Launch action Id.

actionVersion -> (string)

Launch action version.

active -> (boolean)

Whether the launch action is active.

category -> (string)

Launch action category.

description -> (string)

Launch action description.

name -> (string)

Launch action name.

optional -> (boolean)

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

order -> (integer)

Launch action order.

parameters -> (map)

Launch action parameters.

key -> (string)

value -> (structure)

Launch action parameter.

type -> (string)

Type.

value -> (string)

Value.

type -> (string)

Launch action type.

failureReason -> (string)

Failure reason.

runId -> (string)

Run Id.

status -> (string)

Run status.

ssmAgentDiscoveryDatetime -> (string)

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

launchStatus -> (string)

The launch status of a participating server.

recoveryInstanceID -> (string)

The Recovery Instance ID of a participating server.

sourceServerID -> (string)

The Source Server ID of a participating server.

status -> (string)

The status of the Job.

tags -> (map)

A list of tags associated with the Job.

key -> (string)

value -> (string)

type -> (string)

The type of the Job.