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

modify-vpn-tunnel-certificate

Description

Modifies the VPN tunnel endpoint certificate.

See also: AWS API Documentation

Synopsis

  modify-vpn-tunnel-certificate
--vpn-connection-id <value>
--vpn-tunnel-outside-ip-address <value>
[--dry-run | --no-dry-run]
[--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

--vpn-connection-id (string)

The ID of the Amazon Web Services Site-to-Site VPN connection.

--vpn-tunnel-outside-ip-address (string)

The external IP address of the VPN tunnel.

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To rotate a VPN tunnel certificate

The following modify-vpn-tunnel-certificate example rotates the certificate for the specified tunnel for a VPN connection

aws ec2 modify-vpn-tunnel-certificate \
    --vpn-tunnel-outside-ip-address 203.0.113.17 \
    --vpn-connection-id vpn-12345678901234567

Output:

{
    "VpnConnection": {
        "CustomerGatewayConfiguration": ...configuration information...,
        "CustomerGatewayId": "cgw-aabbccddee1122334",
        "Category": "VPN",
        "State": "modifying",
        "Type": "ipsec.1",
        "VpnConnectionId": "vpn-12345678901234567",
        "VpnGatewayId": "vgw-11223344556677889",
        "Options": {
            "StaticRoutesOnly": false
        },
        "VgwTelemetry": [
            {
                "AcceptedRouteCount": 0,
                "LastStatusChange": "2019-09-11T17:27:14.000Z",
                "OutsideIpAddress": "203.0.113.17",
                "Status": "DOWN",
                "StatusMessage": "IPSEC IS DOWN",
                "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example"
            },
            {
                "AcceptedRouteCount": 0,
                "LastStatusChange": "2019-09-11T17:26:47.000Z",
                "OutsideIpAddress": "203.0.114.18",
                "Status": "DOWN",
                "StatusMessage": "IPSEC IS DOWN",
                "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/5ab64566-761b-4ad3-b259-example"
            }
        ]
    }
}

Output

VpnConnection -> (structure)

Information about the VPN connection.

Category -> (string)

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

TransitGatewayId -> (string)

The ID of the transit gateway associated with the VPN connection.

CoreNetworkArn -> (string)

The ARN of the core network.

CoreNetworkAttachmentArn -> (string)

The ARN of the core network attachment.

GatewayAssociationState -> (string)

The current state of the gateway association.

Options -> (structure)

The VPN connection options.

EnableAcceleration -> (boolean)

Indicates whether acceleration is enabled for the VPN connection.

StaticRoutesOnly -> (boolean)

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

LocalIpv4NetworkCidr -> (string)

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

RemoteIpv4NetworkCidr -> (string)

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

LocalIpv6NetworkCidr -> (string)

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

RemoteIpv6NetworkCidr -> (string)

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

OutsideIpAddressType -> (string)

The type of IPv4 address assigned to the outside interface of the customer gateway.

Valid values: PrivateIpv4 | PublicIpv4

Default: PublicIpv4

TransportTransitGatewayAttachmentId -> (string)

The transit gateway attachment ID in use for the VPN tunnel.

TunnelInsideIpVersion -> (string)

Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

TunnelOptions -> (list)

Indicates the VPN tunnel options.

(structure)

The VPN tunnel options.

OutsideIpAddress -> (string)

The external IP address of the VPN tunnel.

TunnelInsideCidr -> (string)

The range of inside IPv4 addresses for the tunnel.

TunnelInsideIpv6Cidr -> (string)

The range of inside IPv6 addresses for the tunnel.

PreSharedKey -> (string)

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.

Phase1LifetimeSeconds -> (integer)

The lifetime for phase 1 of the IKE negotiation, in seconds.

Phase2LifetimeSeconds -> (integer)

The lifetime for phase 2 of the IKE negotiation, in seconds.

RekeyMarginTimeSeconds -> (integer)

The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.

RekeyFuzzPercentage -> (integer)

The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

ReplayWindowSize -> (integer)

The number of packets in an IKE replay window.

DpdTimeoutSeconds -> (integer)

The number of seconds after which a DPD timeout occurs.

DpdTimeoutAction -> (string)

The action to take after a DPD timeout occurs.

Phase1EncryptionAlgorithms -> (list)

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The encryption algorithm for phase 1 IKE negotiations.

Value -> (string)

The value for the encryption algorithm.

Phase2EncryptionAlgorithms -> (list)

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The encryption algorithm for phase 2 IKE negotiations.

Value -> (string)

The encryption algorithm.

Phase1IntegrityAlgorithms -> (list)

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The integrity algorithm for phase 1 IKE negotiations.

Value -> (string)

The value for the integrity algorithm.

Phase2IntegrityAlgorithms -> (list)

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The integrity algorithm for phase 2 IKE negotiations.

Value -> (string)

The integrity algorithm.

Phase1DHGroupNumbers -> (list)

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The Diffie-Hellmann group number for phase 1 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

Phase2DHGroupNumbers -> (list)

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The Diffie-Hellmann group number for phase 2 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

IkeVersions -> (list)

The IKE versions that are permitted for the VPN tunnel.

(structure)

The internet key exchange (IKE) version permitted for the VPN tunnel.

Value -> (string)

The IKE version.

StartupAction -> (string)

The action to take when the establishing the VPN tunnels for a VPN connection.

LogOptions -> (structure)

Options for logging VPN tunnel activity.

CloudWatchLogOptions -> (structure)

Options for sending VPN tunnel logs to CloudWatch.

LogEnabled -> (boolean)

Status of VPN tunnel logging feature. Default value is False .

Valid values: True | False

LogGroupArn -> (string)

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

LogOutputFormat -> (string)

Configured log format. Default format is json .

Valid values: json | text

EnableTunnelLifecycleControl -> (boolean)

Status of tunnel endpoint lifecycle control feature.

Routes -> (list)

The static routes associated with the VPN connection.

(structure)

Describes a static route for a VPN connection.

DestinationCidrBlock -> (string)

The CIDR block associated with the local subnet of the customer data center.

Source -> (string)

Indicates how the routes were provided.

State -> (string)

The current state of the static route.

Tags -> (list)

Any tags assigned to the VPN connection.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

VgwTelemetry -> (list)

Information about the VPN tunnel.

(structure)

Describes telemetry for a VPN tunnel.

AcceptedRouteCount -> (integer)

The number of accepted routes.

LastStatusChange -> (timestamp)

The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.

OutsideIpAddress -> (string)

The Internet-routable IP address of the virtual private gateway's outside interface.

Status -> (string)

The status of the VPN tunnel.

StatusMessage -> (string)

If an error occurs, a description of the error.

CertificateArn -> (string)

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

VpnConnectionId -> (string)

The ID of the VPN connection.

State -> (string)

The current state of the VPN connection.

CustomerGatewayConfiguration -> (string)

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Type -> (string)

The type of VPN connection.

CustomerGatewayId -> (string)

The ID of the customer gateway at your end of the VPN connection.

VpnGatewayId -> (string)

The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.