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

describe-vpc-connector

Description

Return a description of an App Runner VPC connector resource.

See also: AWS API Documentation

Synopsis

  describe-vpc-connector
--vpc-connector-arn <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

--vpc-connector-arn (string)

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

The ARN must be a full VPC connector ARN.

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

VpcConnector -> (structure)

A description of the App Runner VPC connector that you specified in this request.

VpcConnectorName -> (string)

The customer-provided VPC connector name.

VpcConnectorArn -> (string)

The Amazon Resource Name (ARN) of this VPC connector.

VpcConnectorRevision -> (integer)

The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE" ) that share the same Name .

Note

At this time, App Runner supports only one revision per name.

Subnets -> (list)

A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

(string)

SecurityGroups -> (list)

A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

(string)

Status -> (string)

The current state of the VPC connector. If the status of a connector revision is INACTIVE , it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

CreatedAt -> (timestamp)

The time when the VPC connector was created. It's in Unix time stamp format.

DeletedAt -> (timestamp)

The time when the VPC connector was deleted. It's in Unix time stamp format.