[ aws . ec2 . wait ]

customer-gateway-available

Description

Wait until JMESPath query CustomerGateways[].State returns available for all elements when polling with describe-customer-gateways. It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  customer-gateway-available
[--customer-gateway-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--customer-gateway-ids (list)

One or more customer gateway IDs.

Default: Describes all your customer gateways.

(string)

Syntax:

"string" "string" ...

--filters (list)

One or more filters.

• bgp-asn - The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

• customer-gateway-id - The ID of the customer gateway.

• ip-address - The IP address of the customer gateway’s Internet-routable external interface.

• state - The state of the customer gateway (pending | available | deleting | deleted ).

• type - The type of customer gateway. Currently, the only supported type is ipsec.1 .

• tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

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

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

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

See ‘aws help’ for descriptions of global parameters.

Examples

To wait until a customer gateway is available

The following wait customer-gateway-available example pauses and resumes running only after it confirms that the specified customer gateway is available. It produces no output.

aws ec2 wait customer-gateway-available \
    --customer-gateway-ids cgw-1234567890abcdef0

Output

None