Class: AWS.EC2

Inherits:
AWS.Service show all
Identifier:
ec2
API Version:
2016-11-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.

To learn more, see the following resources:

Sending a Request Using EC2

var ec2 = new AWS.EC2();
ec2.applySecurityGroupsToClientVpnTargetNetwork(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EC2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ec2 = new AWS.EC2({apiVersion: '2016-11-15'});

You can also set the API version globally in AWS.config.apiVersions using the ec2 service identifier:

AWS.config.apiVersions = {
  ec2: '2016-11-15',
  // other service API versions
};

var ec2 = new AWS.EC2();

Version:

  • 2016-11-15

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

instanceExists, bundleTaskComplete, conversionTaskCancelled, conversionTaskCompleted, conversionTaskDeleted, customerGatewayAvailable, exportTaskCancelled, exportTaskCompleted, imageExists, imageAvailable, instanceRunning, instanceStatusOk, instanceStopped, instanceTerminated, keyPairExists, natGatewayAvailable, networkInterfaceAvailable, passwordDataAvailable, snapshotCompleted, securityGroupExists, spotInstanceRequestFulfilled, subnetAvailable, systemStatusOk, volumeAvailable, volumeDeleted, volumeInUse, vpcAvailable, vpcExists, vpnConnectionAvailable, vpnConnectionDeleted, vpcPeeringConnectionExists, vpcPeeringConnectionDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.EC2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a EC2 object

var ec2 = new AWS.EC2({apiVersion: '2016-11-15'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.EC2.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.EC2.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.EC2.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptReservedInstancesExchangeQuote(params = {}, callback) ⇒ AWS.Request

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

Service Reference:

Examples:

Calling the acceptReservedInstancesExchangeQuote operation

var params = {
  ReservedInstanceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  TargetConfigurations: [
    {
      OfferingId: 'STRING_VALUE', /* required */
      InstanceCount: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
ec2.acceptReservedInstancesExchangeQuote(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ReservedInstanceIds — (Array<String>)

      The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

    • TargetConfigurations — (Array<map>)

      The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

      • InstanceCount — (Integer)

        The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

      • OfferingId — required — (String)

        The Convertible Reserved Instance offering ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExchangeId — (String)

        The ID of the successful exchange.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request

Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.

Service Reference:

Examples:

Calling the acceptTransitGatewayPeeringAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.acceptTransitGatewayPeeringAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      The ID of the transit gateway attachment.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPeeringAttachment — (map)

        The transit gateway peering attachment.

        • TransitGatewayAttachmentId — (String)

          The ID of the transit gateway peering attachment.

        • RequesterTgwInfo — (map)

          Information about the requester transit gateway.

          • TransitGatewayId — (String)

            The ID of the transit gateway.

          • OwnerId — (String)

            The AWS account ID of the owner of the transit gateway.

          • Region — (String)

            The Region of the transit gateway.

        • AccepterTgwInfo — (map)

          Information about the accepter transit gateway.

          • TransitGatewayId — (String)

            The ID of the transit gateway.

          • OwnerId — (String)

            The AWS account ID of the owner of the transit gateway.

          • Region — (String)

            The Region of the transit gateway.

        • Status — (map)

          The status of the transit gateway peering attachment.

          • Code — (String)

            The status code.

          • Message — (String)

            The status message, if applicable.

        • State — (String)

          The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The time the transit gateway peering attachment was created.

        • Tags — (Array<map>)

          The tags for the transit gateway peering attachment.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

Service Reference:

Examples:

Calling the acceptTransitGatewayVpcAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.acceptTransitGatewayVpcAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      The ID of the attachment.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayVpcAttachment — (map)

        The VPC attachment.

        • TransitGatewayAttachmentId — (String)

          The ID of the attachment.

        • TransitGatewayId — (String)

          The ID of the transit gateway.

        • VpcId — (String)

          The ID of the VPC.

        • VpcOwnerId — (String)

          The ID of the AWS account that owns the VPC.

        • State — (String)

          The state of the VPC attachment. Note that the initiating state has been deprecated.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • SubnetIds — (Array<String>)

          The IDs of the subnets.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The VPC attachment options.

          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • Ipv6Support — (String)

            Indicates whether IPv6 support is disabled.

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the VPC attachment.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

Service Reference:

Examples:

Calling the acceptVpcEndpointConnections operation

var params = {
  ServiceId: 'STRING_VALUE', /* required */
  VpcEndpointIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.acceptVpcEndpointConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ServiceId — (String)

      The ID of the VPC endpoint service.

    • VpcEndpointIds — (Array<String>)

      The IDs of one or more interface VPC endpoints.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the interface endpoints that were not accepted, if applicable.

        • Error — (map)

          Information about the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message accompanying the error code.

        • ResourceId — (String)

          The ID of the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.

For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.

Service Reference:

Examples:

Calling the acceptVpcPeeringConnection operation

var params = {
  DryRun: true || false,
  VpcPeeringConnectionId: 'STRING_VALUE'
};
ec2.acceptVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • VpcPeeringConnectionId — (String)

      The ID of the VPC peering connection. You must specify this parameter in the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringConnection — (map)

        Information about the VPC peering connection.

        • AccepterVpcInfo — (map)

          Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

          • CidrBlock — (String)

            The IPv4 CIDR block for the VPC.

          • Ipv6CidrBlockSet — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The AWS account ID of the VPC owner.

          • PeeringOptions — (map)

            Information about the VPC peering connection options for the accepter or requester VPC.

            • AllowDnsResolutionFromRemoteVpc — (Boolean)

              Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

            • AllowEgressFromLocalClassicLinkToRemoteVpc — (Boolean)

              Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

            • AllowEgressFromLocalVpcToRemoteClassicLink — (Boolean)

              Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

          • VpcId — (String)

            The ID of the VPC.

          • Region — (String)

            The Region in which the VPC is located.

        • ExpirationTime — (Date)

          The time that an unaccepted VPC peering connection will expire.

        • RequesterVpcInfo — (map)

          Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

          • CidrBlock — (String)

            The IPv4 CIDR block for the VPC.

          • Ipv6CidrBlockSet — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The AWS account ID of the VPC owner.

          • PeeringOptions — (map)

            Information about the VPC peering connection options for the accepter or requester VPC.

            • AllowDnsResolutionFromRemoteVpc — (Boolean)

              Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

            • AllowEgressFromLocalClassicLinkToRemoteVpc — (Boolean)

              Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

            • AllowEgressFromLocalVpcToRemoteClassicLink — (Boolean)

              Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

          • VpcId — (String)

            The ID of the VPC.

          • Region — (String)

            The Region in which the VPC is located.

        • Status — (map)

          The status of the VPC peering connection.

          • Code — (String)

            The status of the VPC peering connection.

            Possible values include:
            • "initiating-request"
            • "pending-acceptance"
            • "active"
            • "deleted"
            • "rejected"
            • "failed"
            • "expired"
            • "provisioning"
            • "deleting"
          • Message — (String)

            A message that provides more information about the status, if applicable.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • 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 255 Unicode characters.

        • VpcPeeringConnectionId — (String)

          The ID of the VPC peering connection.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

advertiseByoipCidr(params = {}, callback) ⇒ AWS.Request

Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.

It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

Service Reference:

Examples:

Calling the advertiseByoipCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.advertiseByoipCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Cidr — (String)

      The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ByoipCidr — (map)

        Information about the address range.

        • Cidr — (String)

          The address range, in CIDR notation.

        • Description — (String)

          The description of the address range.

        • StatusMessage — (String)

          Upon success, contains the ID of the address pool. Otherwise, contains an error message.

        • State — (String)

          The state of the address pool.

          Possible values include:
          • "advertised"
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"
          • "provisioned-not-publicly-advertisable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

allocateAddress(params = {}, callback) ⇒ AWS.Request

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

Service Reference:

Examples:

To allocate an Elastic IP address for EC2-VPC


/* This example allocates an Elastic IP address to use with an instance in a VPC. */

 var params = {
  Domain: "vpc"
 };
 ec2.allocateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AllocationId: "eipalloc-64d5890a", 
    Domain: "vpc", 
    PublicIp: "203.0.113.0"
   }
   */
 });

To allocate an Elastic IP address for EC2-Classic


/* This example allocates an Elastic IP address to use with an instance in EC2-Classic. */

 var params = {
 };
 ec2.allocateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Domain: "standard", 
    PublicIp: "198.51.100.0"
   }
   */
 });

Calling the allocateAddress operation

var params = {
  Address: 'STRING_VALUE',
  CustomerOwnedIpv4Pool: 'STRING_VALUE',
  Domain: vpc | standard,
  DryRun: true || false,
  NetworkBorderGroup: 'STRING_VALUE',
  PublicIpv4Pool: 'STRING_VALUE'
};
ec2.allocateAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Domain — (String)

      Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

      Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

      Possible values include:
      • "vpc"
      • "standard"
    • Address — (String)

      [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

    • PublicIpv4Pool — (String)

      The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

    • NetworkBorderGroup — (String)

      A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

      Use DescribeAvailabilityZones to view the network border groups.

      Note: You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.
    • CustomerOwnedIpv4Pool — (String)

      The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PublicIp — (String)

        The Elastic IP address.

      • AllocationId — (String)

        [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

      • PublicIpv4Pool — (String)

        The ID of an address pool.

      • NetworkBorderGroup — (String)

        The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

      • Domain — (String)

        Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).

        Possible values include:
        • "vpc"
        • "standard"
      • CustomerOwnedIp — (String)

        The customer-owned IP address.

      • CustomerOwnedIpv4Pool — (String)

        The ID of the customer-owned address pool.

      • CarrierIp — (String)

        The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

allocateHosts(params = {}, callback) ⇒ AWS.Request

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Service Reference:

Examples:

Calling the allocateHosts operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  Quantity: 'NUMBER_VALUE', /* required */
  AutoPlacement: on | off,
  ClientToken: 'STRING_VALUE',
  HostRecovery: on | off,
  InstanceFamily: 'STRING_VALUE',
  InstanceType: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.allocateHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AutoPlacement — (String)

      Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

      Default: on

      Possible values include:
      • "on"
      • "off"
    • AvailabilityZone — (String)

      The Availability Zone in which to allocate the Dedicated Host.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

    • InstanceType — (String)

      Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

      If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

    • InstanceFamily — (String)

      Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

      If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

    • Quantity — (Integer)

      The number of Dedicated Hosts to allocate to your account with these parameters.

    • TagSpecifications — (Array<map>)

      The tags to apply to the Dedicated Host during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • HostRecovery — (String)

      Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

      Default: off

      Possible values include:
      • "on"
      • "off"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostIds — (Array<String>)

        The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

applySecurityGroupsToClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

Service Reference:

Examples:

Calling the applySecurityGroupsToClientVpnTargetNetwork operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  SecurityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.applySecurityGroupsToClientVpnTargetNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • VpcId — (String)

      The ID of the VPC in which the associated target network is located.

    • SecurityGroupIds — (Array<String>)

      The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroupIds — (Array<String>)

        The IDs of the applied security groups.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

assignIpv6Addresses(params = {}, callback) ⇒ AWS.Request

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

You must specify either the IPv6 addresses or the IPv6 address count in the request.

Service Reference:

Examples:

Calling the assignIpv6Addresses operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  Ipv6AddressCount: 'NUMBER_VALUE',
  Ipv6Addresses: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.assignIpv6Addresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Ipv6AddressCount — (Integer)

      The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

    • Ipv6Addresses — (Array<String>)

      One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssignedIpv6Addresses — (Array<String>)

        The IPv6 addresses assigned to the network interface.

      • NetworkInterfaceId — (String)

        The ID of the network interface.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

assignPrivateIpAddresses(params = {}, callback) ⇒ AWS.Request

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

Service Reference:

Examples:

To assign a specific secondary private IP address to an interface


/* This example assigns the specified secondary private IP address to the specified network interface. */

 var params = {
  NetworkInterfaceId: "eni-e5aa89a3", 
  PrivateIpAddresses: [
     "10.0.0.82"
  ]
 };
 ec2.assignPrivateIpAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To assign secondary private IP addresses that Amazon EC2 selects to an interface


/* This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with. */

 var params = {
  NetworkInterfaceId: "eni-e5aa89a3", 
  SecondaryPrivateIpAddressCount: 2
 };
 ec2.assignPrivateIpAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the assignPrivateIpAddresses operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  AllowReassignment: true || false,
  PrivateIpAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  SecondaryPrivateIpAddressCount: 'NUMBER_VALUE'
};
ec2.assignPrivateIpAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AllowReassignment — (Boolean)

      Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

    • PrivateIpAddresses — (Array<String>)

      One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

      If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

    • SecondaryPrivateIpAddressCount — (Integer)

      The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInterfaceId — (String)

        The ID of the network interface.

      • AssignedPrivateIpAddresses — (Array<map>)

        The private IP addresses assigned to the network interface.

        • PrivateIpAddress — (String)

          The private IP address assigned to the network interface.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateAddress(params = {}, callback) ⇒ AWS.Request

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

Service Reference:

Examples:

To associate an Elastic IP address in EC2-VPC


/* This example associates the specified Elastic IP address with the specified instance in a VPC. */

 var params = {
  AllocationId: "eipalloc-64d5890a", 
  InstanceId: "i-0b263919b6498b123"
 };
 ec2.associateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "eipassoc-2bebb745"
   }
   */
 });

To associate an Elastic IP address with a network interface


/* This example associates the specified Elastic IP address with the specified network interface. */

 var params = {
  AllocationId: "eipalloc-64d5890a", 
  NetworkInterfaceId: "eni-1a2b3c4d"
 };
 ec2.associateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "eipassoc-2bebb745"
   }
   */
 });

To associate an Elastic IP address in EC2-Classic


/* This example associates an Elastic IP address with an instance in EC2-Classic. */

 var params = {
  InstanceId: "i-07ffe74c7330ebf53", 
  PublicIp: "198.51.100.0"
 };
 ec2.associateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the associateAddress operation

var params = {
  AllocationId: 'STRING_VALUE',
  AllowReassociation: true || false,
  DryRun: true || false,
  InstanceId: 'STRING_VALUE',
  NetworkInterfaceId: 'STRING_VALUE',
  PrivateIpAddress: 'STRING_VALUE',
  PublicIp: 'STRING_VALUE'
};
ec2.associateAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AllocationId — (String)

      [EC2-VPC] The allocation ID. This is required for EC2-VPC.

    • InstanceId — (String)

      The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

    • PublicIp — (String)

      The Elastic IP address to associate with the instance. This is required for EC2-Classic.

    • AllowReassociation — (Boolean)

      [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

    • DryRun — (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.

    • NetworkInterfaceId — (String)

      [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

      For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

    • PrivateIpAddress — (String)

      [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        [EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

Service Reference:

Examples:

Calling the associateClientVpnTargetNetwork operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.associateClientVpnTargetNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • SubnetId — (String)

      The ID of the subnet to associate with the Client VPN endpoint.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        The unique ID of the target network association.

      • Status — (map)

        The current state of the target network association.

        • Code — (String)

          The state of the target network association.

          Possible values include:
          • "associating"
          • "associated"
          • "association-failed"
          • "disassociating"
          • "disassociated"
        • Message — (String)

          A message about the status of the target network association, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateDhcpOptions(params = {}, callback) ⇒ AWS.Request

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To associate a DHCP options set with a VPC


/* This example associates the specified DHCP options set with the specified VPC. */

 var params = {
  DhcpOptionsId: "dopt-d9070ebb", 
  VpcId: "vpc-a01106c2"
 };
 ec2.associateDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To associate the default DHCP options set with a VPC


/* This example associates the default DHCP options set with the specified VPC. */

 var params = {
  DhcpOptionsId: "default", 
  VpcId: "vpc-a01106c2"
 };
 ec2.associateDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the associateDhcpOptions operation

var params = {
  DhcpOptionsId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpOptionsId — (String)

      The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

    • VpcId — (String)

      The ID of the VPC.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateIamInstanceProfile(params = {}, callback) ⇒ AWS.Request

Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

Service Reference:

Examples:

To associate an IAM instance profile with an instance


/* This example associates an IAM instance profile named admin-role with the specified instance. */

 var params = {
  IamInstanceProfile: {
   Name: "admin-role"
  }, 
  InstanceId: "i-123456789abcde123"
 };
 ec2.associateIamInstanceProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    IamInstanceProfileAssociation: {
     AssociationId: "iip-assoc-0e7736511a163c209", 
     IamInstanceProfile: {
      Arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
      Id: "AIPAJBLK7RKJKWDXVHIEC"
     }, 
     InstanceId: "i-123456789abcde123", 
     State: "associating"
    }
   }
   */
 });

Calling the associateIamInstanceProfile operation

var params = {
  IamInstanceProfile: { /* required */
    Arn: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE' /* required */
};
ec2.associateIamInstanceProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IamInstanceProfile — (map)

      The IAM instance profile.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the instance profile.

      • Name — (String)

        The name of the instance profile.

    • InstanceId — (String)

      The ID of the instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IamInstanceProfileAssociation — (map)

        Information about the IAM instance profile association.

        • AssociationId — (String)

          The ID of the association.

        • InstanceId — (String)

          The ID of the instance.

        • IamInstanceProfile — (map)

          The IAM instance profile.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the instance profile.

          • Id — (String)

            The ID of the instance profile.

        • State — (String)

          The state of the association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • Timestamp — (Date)

          The time the IAM instance profile was associated with the instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateRouteTable(params = {}, callback) ⇒ AWS.Request

Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To associate a route table with a subnet


/* This example associates the specified route table with the specified subnet. */

 var params = {
  RouteTableId: "rtb-22574640", 
  SubnetId: "subnet-9d4a7b6"
 };
 ec2.associateRouteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "rtbassoc-781d0d1a"
   }
   */
 });

Calling the associateRouteTable operation

var params = {
  RouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  GatewayId: 'STRING_VALUE',
  SubnetId: 'STRING_VALUE'
};
ec2.associateRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • RouteTableId — (String)

      The ID of the route table.

    • SubnetId — (String)

      The ID of the subnet.

    • GatewayId — (String)

      The ID of the internet gateway or virtual private gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        The route table association ID. This ID is required for disassociating the route table.

      • AssociationState — (map)

        The state of the association.

        • State — (String)

          The state of the association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
          • "failed"
        • StatusMessage — (String)

          The status message, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateSubnetCidrBlock(params = {}, callback) ⇒ AWS.Request

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

Service Reference:

Examples:

Calling the associateSubnetCidrBlock operation

var params = {
  Ipv6CidrBlock: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE' /* required */
};
ec2.associateSubnetCidrBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Ipv6CidrBlock — (String)

      The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.

    • SubnetId — (String)

      The ID of your subnet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipv6CidrBlockAssociation — (map)

        Information about the IPv6 CIDR block association.

        • AssociationId — (String)

          The association ID for the CIDR block.

        • Ipv6CidrBlock — (String)

          The IPv6 CIDR block.

        • Ipv6CidrBlockState — (map)

          Information about the state of the CIDR block.

          • State — (String)

            The state of a CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • StatusMessage — (String)

            A message about the status of the CIDR block, if applicable.

      • SubnetId — (String)

        The ID of the subnet.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

Service Reference:

Examples:

Calling the associateTransitGatewayMulticastDomain operation

var params = {
  DryRun: true || false,
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayAttachmentId: 'STRING_VALUE',
  TransitGatewayMulticastDomainId: 'STRING_VALUE'
};
ec2.associateTransitGatewayMulticastDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • TransitGatewayAttachmentId — (String)

      The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

    • SubnetIds — (Array<String>)

      The IDs of the subnets to associate with the transit gateway multicast domain.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Associations — (map)

        Information about the transit gateway multicast domain associations.

        • TransitGatewayMulticastDomainId — (String)

          The ID of the transit gateway multicast domain.

        • TransitGatewayAttachmentId — (String)

          The ID of the transit gateway attachment.

        • ResourceId — (String)

          The ID of the resource.

        • ResourceType — (String)

          The type of resource, for example a VPC attachment.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "peering"
          • "tgw-peering"
        • Subnets — (Array<map>)

          The subnets associated with the multicast domain.

          • SubnetId — (String)

            The ID of the subnet.

          • State — (String)

            The state of the subnet association.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

Service Reference:

Examples:

Calling the associateTransitGatewayRouteTable operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateTransitGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway route table.

    • TransitGatewayAttachmentId — (String)

      The ID of the attachment.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Association — (map)

        The ID of the association.

        • TransitGatewayRouteTableId — (String)

          The ID of the transit gateway route table.

        • TransitGatewayAttachmentId — (String)

          The ID of the attachment.

        • ResourceId — (String)

          The ID of the resource.

        • ResourceType — (String)

          The resource type. Note that the tgw-peering resource type has been deprecated.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "peering"
          • "tgw-peering"
        • State — (String)

          The state of the association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateVpcCidrBlock(params = {}, callback) ⇒ AWS.Request

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

Calling the associateVpcCidrBlock operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  AmazonProvidedIpv6CidrBlock: true || false,
  CidrBlock: 'STRING_VALUE',
  Ipv6CidrBlock: 'STRING_VALUE',
  Ipv6CidrBlockNetworkBorderGroup: 'STRING_VALUE',
  Ipv6Pool: 'STRING_VALUE'
};
ec2.associateVpcCidrBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AmazonProvidedIpv6CidrBlock — (Boolean)

      Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

    • CidrBlock — (String)

      An IPv4 CIDR block to associate with the VPC.

    • VpcId — (String)

      The ID of the VPC.

    • Ipv6CidrBlockNetworkBorderGroup — (String)

      The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

      You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

      You can have one IPv6 CIDR block association per network border group.

    • Ipv6Pool — (String)

      The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

    • Ipv6CidrBlock — (String)

      An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

      To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipv6CidrBlockAssociation — (map)

        Information about the IPv6 CIDR block association.

        • AssociationId — (String)

          The association ID for the IPv6 CIDR block.

        • Ipv6CidrBlock — (String)

          The IPv6 CIDR block.

        • Ipv6CidrBlockState — (map)

          Information about the state of the CIDR block.

          • State — (String)

            The state of the CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • StatusMessage — (String)

            A message about the status of the CIDR block, if applicable.

        • NetworkBorderGroup — (String)

          The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

        • Ipv6Pool — (String)

          The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

      • CidrBlockAssociation — (map)

        Information about the IPv4 CIDR block association.

        • AssociationId — (String)

          The association ID for the IPv4 CIDR block.

        • CidrBlock — (String)

          The IPv4 CIDR block.

        • CidrBlockState — (map)

          Information about the state of the CIDR block.

          • State — (String)

            The state of the CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • StatusMessage — (String)

            A message about the status of the CIDR block, if applicable.

      • VpcId — (String)

        The ID of the VPC.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachClassicLinkVpc(params = {}, callback) ⇒ AWS.Request

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

Service Reference:

Examples:

Calling the attachClassicLinkVpc operation

var params = {
  Groups: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachClassicLinkVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • Groups — (Array<String>)

      The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

    • InstanceId — (String)

      The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

    • VpcId — (String)

      The ID of a ClassicLink-enabled VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachInternetGateway(params = {}, callback) ⇒ AWS.Request

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To attach an Internet gateway to a VPC


/* This example attaches the specified Internet gateway to the specified VPC. */

 var params = {
  InternetGatewayId: "igw-c0a643a9", 
  VpcId: "vpc-a01106c2"
 };
 ec2.attachInternetGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the attachInternetGateway operation

var params = {
  InternetGatewayId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • InternetGatewayId — (String)

      The ID of the internet gateway.

    • VpcId — (String)

      The ID of the VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachNetworkInterface(params = {}, callback) ⇒ AWS.Request

Attaches a network interface to an instance.

Service Reference:

Examples:

To attach a network interface to an instance


/* This example attaches the specified network interface to the specified instance. */

 var params = {
  DeviceIndex: 1, 
  InstanceId: "i-1234567890abcdef0", 
  NetworkInterfaceId: "eni-e5aa89a3"
 };
 ec2.attachNetworkInterface(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AttachmentId: "eni-attach-66c4350a"
   }
   */
 });

Calling the attachNetworkInterface operation

var params = {
  DeviceIndex: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachNetworkInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceIndex — (Integer)

      The index of the device for the network interface attachment.

    • DryRun — (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.

    • InstanceId — (String)

      The ID of the instance.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttachmentId — (String)

        The ID of the network interface attachment.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachVolume(params = {}, callback) ⇒ AWS.Request

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To attach a volume to an instance


/* This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``. */

 var params = {
  Device: "/dev/sdf", 
  InstanceId: "i-01474ef662b89480", 
  VolumeId: "vol-1234567890abcdef0"
 };
 ec2.attachVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AttachTime: <Date Representation>, 
    Device: "/dev/sdf", 
    InstanceId: "i-01474ef662b89480", 
    State: "attaching", 
    VolumeId: "vol-1234567890abcdef0"
   }
   */
 });

Calling the attachVolume operation

var params = {
  Device: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  VolumeId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachVolume(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Device — (String)

      The device name (for example, /dev/sdh or xvdh).

    • InstanceId — (String)

      The ID of the instance.

    • VolumeId — (String)

      The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttachTime — (Date)

        The time stamp when the attachment initiated.

      • Device — (String)

        The device name.

      • InstanceId — (String)

        The ID of the instance.

      • State — (String)

        The attachment state of the volume.

        Possible values include:
        • "attaching"
        • "attached"
        • "detaching"
        • "detached"
        • "busy"
      • VolumeId — (String)

        The ID of the volume.

      • DeleteOnTermination — (Boolean)

        Indicates whether the EBS volume is deleted on instance termination.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachVpnGateway(params = {}, callback) ⇒ AWS.Request

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Service Reference:

Examples:

Calling the attachVpnGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  VpnGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachVpnGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpcId — (String)

      The ID of the VPC.

    • VpnGatewayId — (String)

      The ID of the virtual private gateway.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcAttachment — (map)

        Information about the attachment.

        • State — (String)

          The current state of the attachment.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
        • VpcId — (String)

          The ID of the VPC.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeClientVpnIngress(params = {}, callback) ⇒ AWS.Request

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

Service Reference:

Examples:

Calling the authorizeClientVpnIngress operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  TargetNetworkCidr: 'STRING_VALUE', /* required */
  AccessGroupId: 'STRING_VALUE',
  AuthorizeAllGroups: true || false,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false
};
ec2.authorizeClientVpnIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • TargetNetworkCidr — (String)

      The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

    • AccessGroupId — (String)

      The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

    • AuthorizeAllGroups — (Boolean)

      Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

    • Description — (String)

      A brief description of the authorization rule.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        The current state of the authorization rule.

        • Code — (String)

          The state of the authorization rule.

          Possible values include:
          • "authorizing"
          • "active"
          • "failed"
          • "revoking"
        • Message — (String)

          A message about the status of the authorization rule, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeSecurityGroupEgress(params = {}, callback) ⇒ AWS.Request

[VPC only] Adds the specified egress rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

Service Reference:

Examples:

To add a rule that allows outbound traffic to a specific address range


/* This example adds a rule that grants access to the specified address ranges on TCP port 80. */

 var params = {
  GroupId: "sg-1a2b3c4d", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    IpRanges: [
       {
      CidrIp: "10.0.0.0/16"
     }
    ], 
    ToPort: 80
   }
  ]
 };
 ec2.authorizeSecurityGroupEgress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To add a rule that allows outbound traffic to a specific security group


/* This example adds a rule that grants access to the specified security group on TCP port 80. */

 var params = {
  GroupId: "sg-1a2b3c4d", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    ToPort: 80, 
    UserIdGroupPairs: [
       {
      GroupId: "sg-4b51a32f"
     }
    ]
   }
  ]
 };
 ec2.authorizeSecurityGroupEgress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the authorizeSecurityGroupEgress operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  CidrIp: 'STRING_VALUE',
  DryRun: true || false,
  FromPort: 'NUMBER_VALUE',
  IpPermissions: [
    {
      FromPort: 'NUMBER_VALUE',
      IpProtocol: 'STRING_VALUE',
      IpRanges: [
        {
          CidrIp: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      Ipv6Ranges: [
        {
          CidrIpv6: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      PrefixListIds: [
        {
          Description: 'STRING_VALUE',
          PrefixListId: 'STRING_VALUE'
        },
        /* more items */
      ],
      ToPort: 'NUMBER_VALUE',
      UserIdGroupPairs: [
        {
          Description: 'STRING_VALUE',
          GroupId: 'STRING_VALUE',
          GroupName: 'STRING_VALUE',
          PeeringStatus: 'STRING_VALUE',
          UserId: 'STRING_VALUE',
          VpcId: 'STRING_VALUE',
          VpcPeeringConnectionId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  IpProtocol: 'STRING_VALUE',
  SourceSecurityGroupName: 'STRING_VALUE',
  SourceSecurityGroupOwnerId: 'STRING_VALUE',
  ToPort: 'NUMBER_VALUE'
};
ec2.authorizeSecurityGroupEgress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • GroupId — (String)

      The ID of the security group.

    • IpPermissions — (Array<map>)

      The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

      • FromPort — (Integer)

        The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      • IpProtocol — (String)

        The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

        [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

      • IpRanges — (Array<map>)

        The IPv4 ranges.

        • CidrIp — (String)

          The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.

        • Description — (String)

          A description for the security group rule that references this IPv4 address range.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

      • Ipv6Ranges — (Array<map>)

        [VPC only] The IPv6 ranges.

        • CidrIpv6 — (String)

          The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.

        • Description — (String)

          A description for the security group rule that references this IPv6 address range.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

      • PrefixListIds — (Array<map>)

        [VPC only] The prefix list IDs.

        • Description — (String)

          A description for the security group rule that references this prefix list ID.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

        • PrefixListId — (String)

          The ID of the prefix.

      • ToPort — (Integer)

        The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      • UserIdGroupPairs — (Array<map>)

        The security group and AWS account ID pairs.

        • Description — (String)

          A description for the security group rule that references this user ID group pair.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

        • GroupId — (String)

          The ID of the security group.

        • GroupName — (String)

          The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

          For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

        • PeeringStatus — (String)

          The status of a VPC peering connection, if applicable.

        • UserId — (String)

          The ID of an AWS account.

          For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

          [EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

        • VpcId — (String)

          The ID of the VPC for the referenced security group, if applicable.

        • VpcPeeringConnectionId — (String)

          The ID of the VPC peering connection, if applicable.

    • CidrIp — (String)

      Not supported. Use a set of IP permissions to specify the CIDR.

    • FromPort — (Integer)

      Not supported. Use a set of IP permissions to specify the port.

    • IpProtocol — (String)

      Not supported. Use a set of IP permissions to specify the protocol name or number.

    • ToPort — (Integer)

      Not supported. Use a set of IP permissions to specify the port.

    • SourceSecurityGroupName — (String)

      Not supported. Use a set of IP permissions to specify a destination security group.

    • SourceSecurityGroupOwnerId — (String)

      Not supported. Use a set of IP permissions to specify a destination security group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

Adds the specified ingress rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

Service Reference:

Examples:

To add a rule that allows inbound SSH traffic from an IPv4 address range


/* This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later. */

 var params = {
  GroupId: "sg-903004f8", 
  IpPermissions: [
     {
    FromPort: 22, 
    IpProtocol: "tcp", 
    IpRanges: [
       {
      CidrIp: "203.0.113.0/24", 
      Description: "SSH access from the LA office"
     }
    ], 
    ToPort: 22
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To add a rule that allows inbound HTTP traffic from another security group


/* This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group. */

 var params = {
  GroupId: "sg-111aaa22", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    ToPort: 80, 
    UserIdGroupPairs: [
       {
      Description: "HTTP access from other instances", 
      GroupId: "sg-1a2b3c4d"
     }
    ]
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To add a rule that allows inbound RDP traffic from an IPv6 address range


/* This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later. */

 var params = {
  GroupId: "sg-123abc12 ", 
  IpPermissions: [
     {
    FromPort: 3389, 
    IpProtocol: "tcp", 
    Ipv6Ranges: [
       {
      CidrIpv6: "2001:db8:1234:1a00::/64", 
      Description: "RDP access from the NY office"
     }
    ], 
    ToPort: 3389
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the authorizeSecurityGroupIngress operation

var params = {
  CidrIp: 'STRING_VALUE',
  DryRun: true || false,
  FromPort: 'NUMBER_VALUE',
  GroupId: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  IpPermissions: [
    {
      FromPort: 'NUMBER_VALUE',
      IpProtocol: 'STRING_VALUE',
      IpRanges: [
        {
          CidrIp: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      Ipv6Ranges: [
        {
          CidrIpv6: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      PrefixListIds: [
        {
          Description: 'STRING_VALUE',
          PrefixListId: 'STRING_VALUE'
        },
        /* more items */
      ],
      ToPort: 'NUMBER_VALUE',
      UserIdGroupPairs: [
        {
          Description: 'STRING_VALUE',
          GroupId: 'STRING_VALUE',
          GroupName: 'STRING_VALUE',
          PeeringStatus: 'STRING_VALUE',
          UserId: 'STRING_VALUE',
          VpcId: 'STRING_VALUE',
          VpcPeeringConnectionId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  IpProtocol: 'STRING_VALUE',
  SourceSecurityGroupName: 'STRING_VALUE',
  SourceSecurityGroupOwnerId: 'STRING_VALUE',
  ToPort: 'NUMBER_VALUE'
};
ec2.authorizeSecurityGroupIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CidrIp — (String)

      The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

      Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

    • FromPort — (Integer)

      The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

      Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

    • GroupId — (String)

      The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    • GroupName — (String)

      [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

    • IpPermissions — (Array<map>)

      The sets of IP permissions.

      • FromPort — (Integer)

        The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      • IpProtocol — (String)

        The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

        [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

      • IpRanges — (Array<map>)

        The IPv4 ranges.

        • CidrIp — (String)

          The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.

        • Description — (String)

          A description for the security group rule that references this IPv4 address range.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

      • Ipv6Ranges — (Array<map>)

        [VPC only] The IPv6 ranges.

        • CidrIpv6 — (String)

          The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.

        • Description — (String)

          A description for the security group rule that references this IPv6 address range.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

      • PrefixListIds — (Array<map>)

        [VPC only] The prefix list IDs.

        • Description — (String)

          A description for the security group rule that references this prefix list ID.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

        • PrefixListId — (String)

          The ID of the prefix.

      • ToPort — (Integer)

        The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      • UserIdGroupPairs — (Array<map>)

        The security group and AWS account ID pairs.

        • Description — (String)

          A description for the security group rule that references this user ID group pair.

          Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

        • GroupId — (String)

          The ID of the security group.

        • GroupName — (String)

          The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

          For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

        • PeeringStatus — (String)

          The status of a VPC peering connection, if applicable.

        • UserId — (String)

          The ID of an AWS account.

          For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

          [EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

        • VpcId — (String)

          The ID of the VPC for the referenced security group, if applicable.

        • VpcPeeringConnectionId — (String)

          The ID of the VPC peering connection, if applicable.

    • IpProtocol — (String)

      The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

      [VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

      Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

    • SourceSecurityGroupName — (String)

      [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

    • SourceSecurityGroupOwnerId — (String)

      [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

    • ToPort — (Integer)

      The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

      Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

bundleInstance(params = {}, callback) ⇒ AWS.Request

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.

Note: This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

Service Reference:

Examples:

Calling the bundleInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Storage: { /* required */
    S3: {
      AWSAccessKeyId: 'STRING_VALUE',
      Bucket: 'STRING_VALUE',
      Prefix: 'STRING_VALUE',
      UploadPolicy: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      UploadPolicySignature: 'STRING_VALUE'
    }
  },
  DryRun: true || false
};
ec2.bundleInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InstanceId — (String)

      The ID of the instance to bundle.

      Type: String

      Default: None

      Required: Yes

    • Storage — (map)

      The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

      • S3 — (map)

        An Amazon S3 storage location.

        • AWSAccessKeyId — (String)

          The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

        • Bucket — (String)

          The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

        • Prefix — (String)

          The beginning of the file name of the AMI.

        • UploadPolicy — (Buffer, Typed Array, Blob, String)

          An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

        • UploadPolicySignature — (String)

          The signature of the JSON document.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BundleTask — (map)

        Information about the bundle task.

        • BundleId — (String)

          The ID of the bundle task.

        • BundleTaskError — (map)

          If the task fails, a description of the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

        • InstanceId — (String)

          The ID of the instance associated with this bundle task.

        • Progress — (String)

          The level of task completion, as a percent (for example, 20%).

        • StartTime — (Date)

          The time this task started.

        • State — (String)

          The state of the task.

          Possible values include:
          • "pending"
          • "waiting-for-shutdown"
          • "bundling"
          • "storing"
          • "cancelling"
          • "complete"
          • "failed"
        • Storage — (map)

          The Amazon S3 storage locations.

          • S3 — (map)

            An Amazon S3 storage location.

            • AWSAccessKeyId — (String)

              The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

            • Bucket — (String)

              The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

            • Prefix — (String)

              The beginning of the file name of the AMI.

            • UploadPolicy — (Buffer, Typed Array, Blob, String)

              An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

            • UploadPolicySignature — (String)

              The signature of the JSON document.

        • UpdateTime — (Date)

          The time of the most recent update for the task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelBundleTask(params = {}, callback) ⇒ AWS.Request

Cancels a bundling operation for an instance store-backed Windows instance.

Service Reference:

Examples:

Calling the cancelBundleTask operation

var params = {
  BundleId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.cancelBundleTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BundleId — (String)

      The ID of the bundle task.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BundleTask — (map)

        Information about the bundle task.

        • BundleId — (String)

          The ID of the bundle task.

        • BundleTaskError — (map)

          If the task fails, a description of the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

        • InstanceId — (String)

          The ID of the instance associated with this bundle task.

        • Progress — (String)

          The level of task completion, as a percent (for example, 20%).

        • StartTime — (Date)

          The time this task started.

        • State — (String)

          The state of the task.

          Possible values include:
          • "pending"
          • "waiting-for-shutdown"
          • "bundling"
          • "storing"
          • "cancelling"
          • "complete"
          • "failed"
        • Storage — (map)

          The Amazon S3 storage locations.

          • S3 — (map)

            An Amazon S3 storage location.

            • AWSAccessKeyId — (String)

              The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

            • Bucket — (String)

              The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

            • Prefix — (String)

              The beginning of the file name of the AMI.

            • UploadPolicy — (Buffer, Typed Array, Blob, String)

              An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

            • UploadPolicySignature — (String)

              The signature of the JSON document.

        • UpdateTime — (Date)

          The time of the most recent update for the task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelCapacityReservation(params = {}, callback) ⇒ AWS.Request

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

Service Reference:

Examples:

Calling the cancelCapacityReservation operation

var params = {
  CapacityReservationId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.cancelCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CapacityReservationId — (String)

      The ID of the Capacity Reservation to be cancelled.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelConversionTask(params = {}, callback) ⇒ AWS.Request

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

Service Reference:

Examples:

Calling the cancelConversionTask operation

var params = {
  ConversionTaskId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  ReasonMessage: 'STRING_VALUE'
};
ec2.cancelConversionTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConversionTaskId — (String)

      The ID of the conversion task.

    • DryRun — (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.

    • ReasonMessage — (String)

      The reason for canceling the conversion task.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelExportTask(params = {}, callback) ⇒ AWS.Request

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

Service Reference:

Examples:

Calling the cancelExportTask operation

var params = {
  ExportTaskId: 'STRING_VALUE' /* required */
};
ec2.cancelExportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExportTaskId — (String)

      The ID of the export task. This is the ID returned by CreateInstanceExportTask.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelImportTask(params = {}, callback) ⇒ AWS.Request

Cancels an in-process import virtual machine or import snapshot task.

Service Reference:

Examples:

Calling the cancelImportTask operation

var params = {
  CancelReason: 'STRING_VALUE',
  DryRun: true || false,
  ImportTaskId: 'STRING_VALUE'
};
ec2.cancelImportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CancelReason — (String)

      The reason for canceling the task.

    • DryRun — (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.

    • ImportTaskId — (String)

      The ID of the import image or import snapshot task to be canceled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportTaskId — (String)

        The ID of the task being canceled.

      • PreviousState — (String)

        The current state of the task being canceled.

      • State — (String)

        The current state of the task being canceled.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelReservedInstancesListing(params = {}, callback) ⇒ AWS.Request

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the cancelReservedInstancesListing operation

var params = {
  ReservedInstancesListingId: 'STRING_VALUE' /* required */
};
ec2.cancelReservedInstancesListing(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedInstancesListingId — (String)

      The ID of the Reserved Instance listing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstancesListings — (Array<map>)

        The Reserved Instance listing.

        • ClientToken — (String)

          A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

        • CreateDate — (Date)

          The time the listing was created.

        • InstanceCounts — (Array<map>)

          The number of instances in this state.

          • InstanceCount — (Integer)

            The number of listed Reserved Instances in the state specified by the state.

          • State — (String)

            The states of the listed Reserved Instances.

            Possible values include:
            • "available"
            • "sold"
            • "cancelled"
            • "pending"
        • PriceSchedules — (Array<map>)

          The price of the Reserved Instance listing.

          • Active — (Boolean)

            The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

            A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

          • CurrencyCode — (String)

            The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

            Possible values include:
            • "USD"
          • Price — (Float)

            The fixed price for the term.

          • Term — (Integer)

            The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

        • ReservedInstancesId — (String)

          The ID of the Reserved Instance.

        • ReservedInstancesListingId — (String)

          The ID of the Reserved Instance listing.

        • Status — (String)

          The status of the Reserved Instance listing.

          Possible values include:
          • "active"
          • "pending"
          • "cancelled"
          • "closed"
        • StatusMessage — (String)

          The reason for the current status of the Reserved Instance listing. The response can be blank.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • 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 255 Unicode characters.

        • UpdateDate — (Date)

          The last modified timestamp of the listing.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelSpotFleetRequests(params = {}, callback) ⇒ AWS.Request

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

Service Reference:

Examples:

To cancel a Spot fleet request


/* This example cancels the specified Spot fleet request and terminates its associated Spot Instances. */

 var params = {
  SpotFleetRequestIds: [
     "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
  ], 
  TerminateInstances: true
 };
 ec2.cancelSpotFleetRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SuccessfulFleetRequests: [
       {
      CurrentSpotFleetRequestState: "cancelled_running", 
      PreviousSpotFleetRequestState: "active", 
      SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
     }
    ]
   }
   */
 });

To cancel a Spot fleet request without terminating its Spot Instances


/* This example cancels the specified Spot fleet request without terminating its associated Spot Instances. */

 var params = {
  SpotFleetRequestIds: [
     "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
  ], 
  TerminateInstances: false
 };
 ec2.cancelSpotFleetRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SuccessfulFleetRequests: [
       {
      CurrentSpotFleetRequestState: "cancelled_terminating", 
      PreviousSpotFleetRequestState: "active", 
      SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
     }
    ]
   }
   */
 });

Calling the cancelSpotFleetRequests operation

var params = {
  SpotFleetRequestIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TerminateInstances: true || false, /* required */
  DryRun: true || false
};
ec2.cancelSpotFleetRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • SpotFleetRequestIds — (Array<String>)

      The IDs of the Spot Fleet requests.

    • TerminateInstances — (Boolean)

      Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfulFleetRequests — (Array<map>)

        Information about the Spot Fleet requests that are successfully canceled.

        • CurrentSpotFleetRequestState — (String)

          The current state of the Spot Fleet request.

          Possible values include:
          • "submitted"
          • "active"
          • "cancelled"
          • "failed"
          • "cancelled_running"
          • "cancelled_terminating"
          • "modifying"
        • PreviousSpotFleetRequestState — (String)

          The previous state of the Spot Fleet request.

          Possible values include:
          • "submitted"
          • "active"
          • "cancelled"
          • "failed"
          • "cancelled_running"
          • "cancelled_terminating"
          • "modifying"
        • SpotFleetRequestId — (String)

          The ID of the Spot Fleet request.

      • UnsuccessfulFleetRequests — (Array<map>)

        Information about the Spot Fleet requests that are not successfully canceled.

        • Error — (map)

          The error.

          • Code — (String)

            The error code.

            Possible values include:
            • "fleetRequestIdDoesNotExist"
            • "fleetRequestIdMalformed"
            • "fleetRequestNotInCancellableState"
            • "unexpectedError"
          • Message — (String)

            The description for the error code.

        • SpotFleetRequestId — (String)

          The ID of the Spot Fleet request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelSpotInstanceRequests(params = {}, callback) ⇒ AWS.Request

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Service Reference:

Examples:

To cancel Spot Instance requests


/* This example cancels a Spot Instance request. */

 var params = {
  SpotInstanceRequestIds: [
     "sir-08b93456"
  ]
 };
 ec2.cancelSpotInstanceRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CancelledSpotInstanceRequests: [
       {
      SpotInstanceRequestId: "sir-08b93456", 
      State: "cancelled"
     }
    ]
   }
   */
 });

Calling the cancelSpotInstanceRequests operation

var params = {
  SpotInstanceRequestIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.cancelSpotInstanceRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • SpotInstanceRequestIds — (Array<String>)

      One or more Spot Instance request IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CancelledSpotInstanceRequests — (Array<map>)

        One or more Spot Instance requests.

        • SpotInstanceRequestId — (String)

          The ID of the Spot Instance request.

        • State — (String)

          The state of the Spot Instance request.

          Possible values include:
          • "active"
          • "open"
          • "closed"
          • "cancelled"
          • "completed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

confirmProductInstance(params = {}, callback) ⇒ AWS.Request

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.

Service Reference:

Examples:

To confirm the product instance


/* This example determines whether the specified product code is associated with the specified instance. */

 var params = {
  InstanceId: "i-1234567890abcdef0", 
  ProductCode: "774F4FF8"
 };
 ec2.confirmProductInstance(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OwnerId: "123456789012"
   }
   */
 });

Calling the confirmProductInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ProductCode: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.confirmProductInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InstanceId — (String)

      The ID of the instance.

    • ProductCode — (String)

      The product code. This must be a product code that you own.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnerId — (String)

        The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

      • Return — (Boolean)

        The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyFpgaImage(params = {}, callback) ⇒ AWS.Request

Copies the specified Amazon FPGA Image (AFI) to the current Region.

Service Reference:

Examples:

Calling the copyFpgaImage operation

var params = {
  SourceFpgaImageId: 'STRING_VALUE', /* required */
  SourceRegion: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  Name: 'STRING_VALUE'
};
ec2.copyFpgaImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • SourceFpgaImageId — (String)

      The ID of the source AFI.

    • Description — (String)

      The description for the new AFI.

    • Name — (String)

      The name for the new AFI. The default is the name of the source AFI.

    • SourceRegion — (String)

      The Region that contains the source AFI.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImageId — (String)

        The ID of the new AFI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyImage(params = {}, callback) ⇒ AWS.Request

Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.

Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To copy an AMI to another region


/* This example copies the specified AMI from the us-east-1 region to the current region. */

 var params = {
  Description: "", 
  Name: "My server", 
  SourceImageId: "ami-5731123e", 
  SourceRegion: "us-east-1"
 };
 ec2.copyImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImageId: "ami-438bea42"
   }
   */
 });

Calling the copyImage operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SourceImageId: 'STRING_VALUE', /* required */
  SourceRegion: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  Encrypted: true || false,
  KmsKeyId: 'STRING_VALUE'
};
ec2.copyImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

    • Description — (String)

      A description for the new AMI in the destination Region.

    • Encrypted — (Boolean)

      Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

    • KmsKeyId — (String)

      An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

      To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

      AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

      The specified CMK must exist in the Region that the snapshot is being copied to.

      Amazon EBS does not support asymmetric CMKs.

    • Name — (String)

      The name of the new AMI in the destination Region.

    • SourceImageId — (String)

      The ID of the AMI to copy.

    • SourceRegion — (String)

      The name of the Region that contains the AMI to copy.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageId — (String)

        The ID of the new AMI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copySnapshot(params = {}, callback) ⇒ AWS.Request

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To copy a snapshot


/* This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot. */

 var params = {
  Description: "This is my copied snapshot.", 
  DestinationRegion: "us-east-1", 
  SourceRegion: "us-west-2", 
  SourceSnapshotId: "snap-066877671789bd71b"
 };
 ec2.copySnapshot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SnapshotId: "snap-066877671789bd71b"
   }
   */
 });

Calling the copySnapshot operation

var params = {
  SourceRegion: 'STRING_VALUE', /* required */
  SourceSnapshotId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DestinationRegion: 'STRING_VALUE',
  DryRun: true || false,
  Encrypted: true || false,
  KmsKeyId: 'STRING_VALUE',
  PresignedUrl: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.copySnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for the EBS snapshot.

    • DestinationRegion — (String)

      The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

      The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.

    • Encrypted — (Boolean)

      To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

    • KmsKeyId — (String)

      The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

      You can specify the CMK using any of the following:

      • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Key alias. For example, alias/ExampleAlias.

      • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

      • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

      AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

    • PresignedUrl — (String)

      When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

      The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

    • SourceRegion — (String)

      The ID of the Region that contains the snapshot to be copied.

    • SourceSnapshotId — (String)

      The ID of the EBS snapshot to copy.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new snapshot.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotId — (String)

        The ID of the new snapshot.

      • Tags — (Array<map>)

        Any tags applied to the new snapshot.

        • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCapacityReservation(params = {}, callback) ⇒ AWS.Request

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the createCapacityReservation operation

var params = {
  InstanceCount: 'NUMBER_VALUE', /* required */
  InstancePlatform: Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Windows with SQL Server | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise, /* required */
  InstanceType: 'STRING_VALUE', /* required */
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneId: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  EbsOptimized: true || false,
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EndDateType: unlimited | limited,
  EphemeralStorage: true || false,
  InstanceMatchCriteria: open | targeted,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tenancy: default | dedicated
};
ec2.createCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

    • InstanceType — (String)

      The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

    • InstancePlatform — (String)

      The type of operating system for which to reserve capacity.

      Possible values include:
      • "Linux/UNIX"
      • "Red Hat Enterprise Linux"
      • "SUSE Linux"
      • "Windows"
      • "Windows with SQL Server"
      • "Windows with SQL Server Enterprise"
      • "Windows with SQL Server Standard"
      • "Windows with SQL Server Web"
      • "Linux with SQL Server Standard"
      • "Linux with SQL Server Web"
      • "Linux with SQL Server Enterprise"
    • AvailabilityZone — (String)

      The Availability Zone in which to create the Capacity Reservation.

    • AvailabilityZoneId — (String)

      The ID of the Availability Zone in which to create the Capacity Reservation.

    • Tenancy — (String)

      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

      Possible values include:
      • "default"
      • "dedicated"
    • InstanceCount — (Integer)

      The number of instances for which to reserve capacity.

    • EbsOptimized — (Boolean)

      Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

    • EphemeralStorage — (Boolean)

      Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

    • EndDate — (Date)

      The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

      You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

      If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

    • EndDateType — (String)

      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

      • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

      Possible values include:
      • "unlimited"
      • "limited"
    • InstanceMatchCriteria — (String)

      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      Default: open

      Possible values include:
      • "open"
      • "targeted"
    • TagSpecifications — (Array<map>)

      The tags to apply to the Capacity Reservation during launch.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CapacityReservation — (map)

        Information about the Capacity Reservation.

        • CapacityReservationId — (String)

          The ID of the Capacity Reservation.

        • OwnerId — (String)

          The ID of the AWS account that owns the Capacity Reservation.

        • CapacityReservationArn — (String)

          The Amazon Resource Name (ARN) of the Capacity Reservation.

        • AvailabilityZoneId — (String)

          The Availability Zone ID of the Capacity Reservation.

        • InstanceType — (String)

          The type of instance for which the Capacity Reservation reserves capacity.

        • InstancePlatform — (String)

          The type of operating system for which the Capacity Reservation reserves capacity.

          Possible values include:
          • "Linux/UNIX"
          • "Red Hat Enterprise Linux"
          • "SUSE Linux"
          • "Windows"
          • "Windows with SQL Server"
          • "Windows with SQL Server Enterprise"
          • "Windows with SQL Server Standard"
          • "Windows with SQL Server Web"
          • "Linux with SQL Server Standard"
          • "Linux with SQL Server Web"
          • "Linux with SQL Server Enterprise"
        • AvailabilityZone — (String)

          The Availability Zone in which the capacity is reserved.

        • Tenancy — (String)

          Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

          • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

          • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

          Possible values include:
          • "default"
          • "dedicated"
        • TotalInstanceCount — (Integer)

          The total number of instances for which the Capacity Reservation reserves capacity.

        • AvailableInstanceCount — (Integer)

          The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

        • EbsOptimized — (Boolean)

          Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

        • EphemeralStorage — (Boolean)

          Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

        • State — (String)

          The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

          • active - The Capacity Reservation is active and the capacity is available for your use.

          • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

          • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

          • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

          • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

          Possible values include:
          • "active"
          • "expired"
          • "cancelled"
          • "pending"
          • "failed"
        • EndDate — (Date)

          The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

        • EndDateType — (String)

          Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

          • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

          • limited - The Capacity Reservation expires automatically at a specified date and time.

          Possible values include:
          • "unlimited"
          • "limited"
        • InstanceMatchCriteria — (String)

          Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

          • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

          • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

          Possible values include:
          • "open"
          • "targeted"
        • CreateDate — (Date)

          The date and time at which the Capacity Reservation was created.

        • Tags — (Array<map>)

          Any tags assigned to the Capacity Reservation.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCarrierGateway(params = {}, callback) ⇒ AWS.Request

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.

Service Reference:

Examples:

Calling the createCarrierGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCarrierGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpcId — (String)

      The ID of the VPC to associate with the carrier gateway.

    • TagSpecifications — (Array<map>)

      The tags to associate with the carrier gateway.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CarrierGateway — (map)

        Information about the carrier gateway.

        • CarrierGatewayId — (String)

          The ID of the carrier gateway.

        • VpcId — (String)

          The ID of the VPC associated with the carrier gateway.

        • State — (String)

          The state of the carrier gateway.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The AWS account ID of the owner of the carrier gateway.

        • Tags — (Array<map>)

          The tags assigned to the carrier gateway.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Service Reference:

Examples:

Calling the createClientVpnEndpoint operation

var params = {
  AuthenticationOptions: [ /* required */
    {
      ActiveDirectory: {
        DirectoryId: 'STRING_VALUE'
      },
      FederatedAuthentication: {
        SAMLProviderArn: 'STRING_VALUE'
      },
      MutualAuthentication: {
        ClientRootCertificateChainArn: 'STRING_VALUE'
      },
      Type: certificate-authentication | directory-service-authentication | federated-authentication
    },
    /* more items */
  ],
  ClientCidrBlock: 'STRING_VALUE', /* required */
  ConnectionLogOptions: { /* required */
    CloudwatchLogGroup: 'STRING_VALUE',
    CloudwatchLogStream: 'STRING_VALUE',
    Enabled: true || false
  },
  ServerCertificateArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DnsServers: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SplitTunnel: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TransportProtocol: tcp | udp,
  VpcId: 'STRING_VALUE',
  VpnPort: 'NUMBER_VALUE'
};
ec2.createClientVpnEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientCidrBlock — (String)

      The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

    • ServerCertificateArn — (String)

      The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.

    • AuthenticationOptions — (Array<map>)

      Information about the authentication method to be used to authenticate clients.

      • Type — (String)

        The type of client authentication to be used.

        Possible values include:
        • "certificate-authentication"
        • "directory-service-authentication"
        • "federated-authentication"
      • ActiveDirectory — (map)

        Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

        • DirectoryId — (String)

          The ID of the Active Directory to be used for authentication.

      • MutualAuthentication — (map)

        Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

        • ClientRootCertificateChainArn — (String)

          The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

      • FederatedAuthentication — (map)

        Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

        • SAMLProviderArn — (String)

          The Amazon Resource Name (ARN) of the IAM SAML identity provider.

    • ConnectionLogOptions — (map)

      Information about the client connection logging options.

      If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

      • Client connection requests

      • Client connection results (successful and unsuccessful)

      • Reasons for unsuccessful client connection requests

      • Client connection termination time

      • Enabled — (Boolean)

        Indicates whether connection logging is enabled.

      • CloudwatchLogGroup — (String)

        The name of the CloudWatch Logs log group. Required if connection logging is enabled.

      • CloudwatchLogStream — (String)

        The name of the CloudWatch Logs log stream to which the connection data is published.

    • DnsServers — (Array<String>)

      Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

    • TransportProtocol — (String)

      The transport protocol to be used by the VPN session.

      Default value: udp

      Possible values include:
      • "tcp"
      • "udp"
    • VpnPort — (Integer)

      The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

      Valid Values: 443 | 1194

      Default Value: 443

    • Description — (String)

      A brief description of the Client VPN endpoint.

    • SplitTunnel — (Boolean)

      Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

      By default, split-tunnel on a VPN endpoint is disabled.

      For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.

    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TagSpecifications — (Array<map>)

      The tags to apply to the Client VPN endpoint during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • SecurityGroupIds — (Array<String>)

      The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

    • VpcId — (String)

      The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientVpnEndpointId — (String)

        The ID of the Client VPN endpoint.

      • Status — (map)

        The current state of the Client VPN endpoint.

        • Code — (String)

          The state of the Client VPN endpoint. Possible states include:

          • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.

          • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.

          • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.

          • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

          Possible values include:
          • "pending-associate"
          • "available"
          • "deleting"
          • "deleted"
        • Message — (String)

          A message about the status of the Client VPN endpoint.

      • DnsName — (String)

        The DNS name to be used by clients when establishing their VPN session.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClientVpnRoute(params = {}, callback) ⇒ AWS.Request

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

Service Reference:

Examples:

Calling the createClientVpnRoute operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  TargetVpcSubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false
};
ec2.createClientVpnRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint to which to add the route.

    • DestinationCidrBlock — (String)

      The IPv4 address range, in CIDR notation, of the route destination. For example:

      • To add a route for Internet access, enter 0.0.0.0/0

      • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

      • To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range

      Route address ranges cannot overlap with the CIDR range specified for client allocation.

    • TargetVpcSubnetId — (String)

      The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

    • Description — (String)

      A brief description of the route.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        The current state of the route.

        • Code — (String)

          The state of the Client VPN endpoint route.

          Possible values include:
          • "creating"
          • "active"
          • "failed"
          • "deleting"
        • Message — (String)

          A message about the status of the Client VPN endpoint route, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCustomerGateway(params = {}, callback) ⇒ AWS.Request

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Note: Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:
  • 7224 - reserved in the us-east-1 Region
  • 9059 - reserved in the eu-west-1 Region
  • 17943 - reserved in the ap-southeast-1 Region
  • 10124 - reserved in the ap-northeast-1 Region

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.

Service Reference:

Examples:

To create a customer gateway


/* This example creates a customer gateway with the specified IP address for its outside interface. */

 var params = {
  BgpAsn: 65534, 
  PublicIp: "12.1.2.3", 
  Type: "ipsec.1"
 };
 ec2.createCustomerGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomerGateway: {
     BgpAsn: "65534", 
     CustomerGatewayId: "cgw-0e11f167", 
     IpAddress: "12.1.2.3", 
     State: "available", 
     Type: "ipsec.1"
    }
   }
   */
 });

Calling the createCustomerGateway operation

var params = {
  BgpAsn: 'NUMBER_VALUE', /* required */
  Type: ipsec.1, /* required */
  CertificateArn: 'STRING_VALUE',
  DeviceName: 'STRING_VALUE',
  DryRun: true || false,
  PublicIp: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCustomerGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BgpAsn — (Integer)

      For devices that support BGP, the customer gateway's BGP ASN.

      Default: 65000

    • PublicIp — (String)

      The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

    • CertificateArn — (String)

      The Amazon Resource Name (ARN) for the customer gateway certificate.

    • Type — (String)

      The type of VPN connection that this customer gateway supports (ipsec.1).

      Possible values include:
      • "ipsec.1"
    • TagSpecifications — (Array<map>)

      The tags to apply to the customer gateway.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DeviceName — (String)

      A name for the customer gateway device.

      Length Constraints: Up to 255 characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGateway — (map)

        Information about the customer gateway.

        • BgpAsn — (String)

          The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

        • CustomerGatewayId — (String)

          The ID of the customer gateway.

        • IpAddress — (String)

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

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) for the customer gateway certificate.

        • State — (String)

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

        • Type — (String)

          The type of VPN connection the customer gateway supports (ipsec.1).

        • DeviceName — (String)

          The name of customer gateway device.

        • Tags — (Array<map>)

          Any tags assigned to the customer gateway.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDefaultSubnet(params = {}, callback) ⇒ AWS.Request

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

Calling the createDefaultSubnet operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.createDefaultSubnet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String)

      The Availability Zone in which to create the default subnet.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subnet — (map)

        Information about the subnet.

        • AvailabilityZone — (String)

          The Availability Zone of the subnet.

        • AvailabilityZoneId — (String)

          The AZ ID of the subnet.

        • AvailableIpAddressCount — (Integer)

          The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

        • CidrBlock — (String)

          The IPv4 CIDR block assigned to the subnet.

        • DefaultForAz — (Boolean)

          Indicates whether this is the default subnet for the Availability Zone.

        • MapPublicIpOnLaunch — (Boolean)

          Indicates whether instances launched in this subnet receive a public IPv4 address.

        • MapCustomerOwnedIpOnLaunch — (Boolean)

          Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

        • CustomerOwnedIpv4Pool — (String)

          The customer-owned IPv4 address pool associated with the subnet.

        • State — (String)

          The current state of the subnet.

          Possible values include:
          • "pending"
          • "available"
        • SubnetId — (String)

          The ID of the subnet.

        • VpcId — (String)

          The ID of the VPC the subnet is in.

        • OwnerId — (String)

          The ID of the AWS account that owns the subnet.

        • AssignIpv6AddressOnCreation — (Boolean)

          Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

        • Ipv6CidrBlockAssociationSet — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the subnet.

          • AssociationId — (String)

            The association ID for the CIDR block.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of a CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • StatusMessage — (String)

              A message about the status of the CIDR block, if applicable.

        • Tags — (Array<map>)

          Any tags assigned to the subnet.

          • 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 255 Unicode characters.

        • SubnetArn — (String)

          The Amazon Resource Name (ARN) of the subnet.

        • OutpostArn — (String)

          The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDefaultVpc(params = {}, callback) ⇒ AWS.Request

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.

Service Reference:

Examples:

Calling the createDefaultVpc operation

var params = {
  DryRun: true || false
};
ec2.createDefaultVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Vpc — (map)

        Information about the VPC.

        • CidrBlock — (String)

          The primary IPv4 CIDR block for the VPC.

        • DhcpOptionsId — (String)

          The ID of the set of DHCP options you've associated with the VPC.

        • State — (String)

          The current state of the VPC.

          Possible values include:
          • "pending"
          • "available"
        • VpcId — (String)

          The ID of the VPC.

        • OwnerId — (String)

          The ID of the AWS account that owns the VPC.

        • InstanceTenancy — (String)

          The allowed tenancy of instances launched into the VPC.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • Ipv6CidrBlockAssociationSet — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv6 CIDR block.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • StatusMessage — (String)

              A message about the status of the CIDR block, if applicable.

          • NetworkBorderGroup — (String)

            The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

          • Ipv6Pool — (String)

            The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

        • CidrBlockAssociationSet — (Array<map>)

          Information about the IPv4 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv4 CIDR block.

          • CidrBlock — (String)

            The IPv4 CIDR block.

          • CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • StatusMessage — (String)

              A message about the status of the CIDR block, if applicable.

        • IsDefault — (Boolean)

          Indicates whether the VPC is the default VPC.

        • Tags — (Array<map>)

          Any tags assigned to the VPC.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDhcpOptions(params = {}, callback) ⇒ AWS.Request

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To create a DHCP options set


/* This example creates a DHCP options set. */

 var params = {
  DhcpConfigurations: [
     {
    Key: "domain-name-servers", 
    Values: [
       "10.2.5.1", 
       "10.2.5.2"
    ]
   }
  ]
 };
 ec2.createDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DhcpOptions: {
     DhcpConfigurations: [
        {
       Key: "domain-name-servers", 
       Values: [
          {
         Value: "10.2.5.2"
        }, 
          {
         Value: "10.2.5.1"
        }
       ]
      }
     ], 
     DhcpOptionsId: "dopt-d9070ebb"
    }
   }
   */
 });

Calling the createDhcpOptions operation

var params = {
  DhcpConfigurations: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpConfigurations — (Array<map>)

      A DHCP configuration option.

      • Key — (String)
      • Values — (Array<String>)
    • TagSpecifications — (Array<map>)

      The tags to assign to the DHCP option.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DhcpOptions — (map)

        A set of DHCP options.

        • DhcpConfigurations — (Array<map>)

          One or more DHCP options in the set.

          • Key — (String)

            The name of a DHCP option.

          • Values — (Array<map>)

            One or more values for the DHCP option.

            • Value — (String)

              The attribute value. The value is case-sensitive.

        • DhcpOptionsId — (String)

          The ID of the set of DHCP options.

        • OwnerId — (String)

          The ID of the AWS account that owns the DHCP options set.

        • Tags — (Array<map>)

          Any tags assigned to the DHCP options set.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

Service Reference:

Examples:

Calling the createEgressOnlyInternetGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createEgressOnlyInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

    • DryRun — (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.

    • VpcId — (String)

      The ID of the VPC for which to create the egress-only internet gateway.

    • TagSpecifications — (Array<map>)

      The tags to assign to the egress-only internet gateway.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      • EgressOnlyInternetGateway — (map)

        Information about the egress-only internet gateway.

        • Attachments — (Array<map>)

          Information about the attachment of the egress-only internet gateway.

          • State — (String)

            The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • EgressOnlyInternetGatewayId — (String)

          The ID of the egress-only internet gateway.

        • Tags — (Array<map>)

          The tags assigned to the egress-only internet gateway.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFleet(params = {}, callback) ⇒ AWS.Request

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  LaunchTemplateConfigs: [ /* required */
    {
      LaunchTemplateSpecification: {
        LaunchTemplateId: 'STRING_VALUE',
        LaunchTemplateName: 'STRING_VALUE',
        Version: 'STRING_VALUE'
      },
      Overrides: [
        {
          AvailabilityZone: 'STRING_VALUE',
          InstanceType: t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r6g.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6gd.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | hi1.4xlarge | hs1.8xlarge | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c6g.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6gd.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | cc1.4xlarge | cc2.8xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | cg1.4xlarge | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge,
          MaxPrice: 'STRING_VALUE',
          Placement: {
            Affinity: 'STRING_VALUE',
            AvailabilityZone: 'STRING_VALUE',
            GroupName: 'STRING_VALUE',
            HostId: 'STRING_VALUE',
            HostResourceGroupArn: 'STRING_VALUE',
            PartitionNumber: 'NUMBER_VALUE',
            SpreadDomain: 'STRING_VALUE',
            Tenancy: default | dedicated | host
          },
          Priority: 'NUMBER_VALUE',
          SubnetId: 'STRING_VALUE',
          WeightedCapacity: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TargetCapacitySpecification: { /* required */
    TotalTargetCapacity: 'NUMBER_VALUE', /* required */
    DefaultTargetCapacityType: spot | on-demand,
    OnDemandTargetCapacity: 'NUMBER_VALUE',
    SpotTargetCapacity: 'NUMBER_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  ExcessCapacityTerminationPolicy: no-termination | termination,
  OnDemandOptions: {
    AllocationStrategy: lowest-price | prioritized,
    CapacityReservationOptions: {
      UsageStrategy: use-capacity-reservations-first
    },
    MaxTotalPrice: 'STRING_VALUE',
    MinTargetCapacity: 'NUMBER_VALUE',
    SingleAvailabilityZone: true || false,
    SingleInstanceType: true || false
  },
  ReplaceUnhealthyInstances: true || false,
  SpotOptions: {
    AllocationStrategy: lowest-price | diversified | capacity-optimized,
    InstanceInterruptionBehavior: hibernate | stop | terminate,
    InstancePoolsToUseCount: 'NUMBER_VALUE',
    MaxTotalPrice: 'STRING_VALUE',
    MinTargetCapacity: 'NUMBER_VALUE',
    SingleAvailabilityZone: true || false,
    SingleInstanceType: true || false
  },
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TerminateInstancesWithExpiration: true || false,
  Type: request | maintain | instant,
  ValidFrom: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
ec2.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    • SpotOptions — (map)

      Describes the configuration of Spot Instances in an EC2 Fleet.

      • AllocationStrategy — (String)

        Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

        If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

        If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

        If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

        Possible values include:
        • "lowest-price"
        • "diversified"
        • "capacity-optimized"
      • InstanceInterruptionBehavior — (String)

        The behavior when a Spot Instance is interrupted. The default is terminate.

        Possible values include:
        • "hibernate"
        • "stop"
        • "terminate"
      • InstancePoolsToUseCount — (Integer)

        The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

      • SingleInstanceType — (Boolean)

        Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant.

      • SingleAvailabilityZone — (Boolean)

        Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant.

      • MinTargetCapacity — (Integer)

        The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

      • MaxTotalPrice — (String)

        The maximum amount per hour for Spot Instances that you're willing to pay.

    • OnDemandOptions — (map)

      Describes the configuration of On-Demand Instances in an EC2 Fleet.

      • AllocationStrategy — (String)

        The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.

        Possible values include:
        • "lowest-price"
        • "prioritized"
      • CapacityReservationOptions — (map)

        The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant.

        • UsageStrategy — (String)

          Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

          If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

          If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

          Possible values include:
          • "use-capacity-reservations-first"
      • SingleInstanceType — (Boolean)

        Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant.

      • SingleAvailabilityZone — (Boolean)

        Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant.

      • MinTargetCapacity — (Integer)

        The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

      • MaxTotalPrice — (String)

        The maximum amount per hour for On-Demand Instances that you're willing to pay.

    • ExcessCapacityTerminationPolicy — (String)

      Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

      Possible values include:
      • "no-termination"
      • "termination"
    • LaunchTemplateConfigs — (Array<map>)

      The configuration for the EC2 Fleet.

      • LaunchTemplateSpecification — (map)

        The launch template to use. You must specify either the launch template ID or launch template name in the request.

        • LaunchTemplateId — (String)

          The ID of the launch template. If you specify the template ID, you can't specify the template name.

        • LaunchTemplateName — (String)

          The name of the launch template. If you specify the template name, you can't specify the template ID.

        • Version — (String)

          The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

          If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

          If the value is $Default, Amazon EC2 uses the default version of the launch template.

      • Overrides — (Array<map>)

        Any parameters that you specify override the same parameters in the launch template.

        • InstanceType — (String)

          The instance type.

          Possible values include:
          • "t1.micro"
          • "t2.nano"
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "t2.xlarge"
          • "t2.2xlarge"
          • "t3.nano"
          • "t3.micro"
          • "t3.small"
          • "t3.medium"
          • "t3.large"
          • "t3.xlarge"
          • "t3.2xlarge"
          • "t3a.nano"
          • "t3a.micro"
          • "t3a.small"
          • "t3a.medium"
          • "t3a.large"
          • "t3a.xlarge"
          • "t3a.2xlarge"
          • "t4g.nano"
          • "t4g.micro"
          • "t4g.small"
          • "t4g.medium"
          • "t4g.large"
          • "t4g.xlarge"
          • "t4g.2xlarge"
          • "m1.small"
          • "m1.medium"
          • "m1.large"
          • "m1.xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m4.16xlarge"
          • "m2.xlarge"
          • "m2.2xlarge"
          • "m2.4xlarge"
          • "cr1.8xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5.metal"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "r5d.large"
          • "r5d.xlarge"
          • "r5d.2xlarge"
          • "r5d.4xlarge"
          • "r5d.8xlarge"
          • "r5d.12xlarge"
          • "r5d.16xlarge"
          • "r5d.24xlarge"
          • "r5d.metal"
          • "r5ad.large"
          • "r5ad.xlarge"
          • "r5ad.2xlarge"
          • "r5ad.4xlarge"
          • "r5ad.8xlarge"
          • "r5ad.12xlarge"
          • "r5ad.16xlarge"
          • "r5ad.24xlarge"
          • "r6g.metal"
          • "r6g.medium"
          • "r6g.large"
          • "r6g.xlarge"
          • "r6g.2xlarge"
          • "r6g.4xlarge"
          • "r6g.8xlarge"
          • "r6g.12xlarge"
          • "r6g.16xlarge"
          • "r6gd.metal"
          • "r6gd.medium"
          • "r6gd.large"
          • "r6gd.xlarge"
          • "r6gd.2xlarge"
          • "r6gd.4xlarge"
          • "r6gd.8xlarge"
          • "r6gd.12xlarge"
          • "r6gd.16xlarge"
          • "x1.16xlarge"
          • "x1.32xlarge"
          • "x1e.xlarge"
          • "x1e.2xlarge"
          • "x1e.4xlarge"
          • "x1e.8xlarge"
          • "x1e.16xlarge"
          • "x1e.32xlarge"
          • "i2.xlarge"
          • "i2.2xlarge"
          • "i2.4xlarge"
          • "i2.8xlarge"
          • "i3.large"
          • "i3.xlarge"
          • "i3.2xlarge"
          • "i3.4xlarge"
          • "i3.8xlarge"
          • "i3.16xlarge"
          • "i3.metal"
          • "i3en.large"
          • "i3en.xlarge"
          • "i3en.2xlarge"
          • "i3en.3xlarge"
          • "i3en.6xlarge"
          • "i3en.12xlarge"
          • "i3en.24xlarge"
          • "i3en.metal"
          • "hi1.4xlarge"
          • "hs1.8xlarge"
          • "c1.medium"
          • "c1.xlarge"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5.metal"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "c5ad.large"
          • "c5ad.xlarge"
          • "c5ad.2xlarge"
          • "c5ad.4xlarge"
          • "c5ad.8xlarge"
          • "c5ad.12xlarge"
          • "c5ad.16xlarge"
          • "c5ad.24xlarge"
          • "c5d.large"
          • "c5d.xlarge"
          • "c5d.2xlarge"
          • "c5d.4xlarge"
          • "c5d.9xlarge"
          • "c5d.12xlarge"
          • "c5d.18xlarge"
          • "c5d.24xlarge"
          • "c5d.metal"
          • "c5n.large"
          • "c5n.xlarge"
          • "c5n.2xlarge"
          • "c5n.4xlarge"
          • "c5n.9xlarge"
          • "c5n.18xlarge"
          • "c6g.metal"
          • "c6g.medium"
          • "c6g.large"
          • "c6g.xlarge"
          • "c6g.2xlarge"
          • "c6g.4xlarge"
          • "c6g.8xlarge"
          • "c6g.12xlarge"
          • "c6g.16xlarge"
          • "c6gd.metal"
          • "c6gd.medium"
          • "c6gd.large"
          • "c6gd.xlarge"
          • "c6gd.2xlarge"
          • "c6gd.4xlarge"
          • "c6gd.8xlarge"
          • "c6gd.12xlarge"
          • "c6gd.16xlarge"
          • "cc1.4xlarge"
          • "cc2.8xlarge"
          • "g2.2xlarge"
          • "g2.8xlarge"
          • "g3.4xlarge"
          • "g3.8xlarge"
          • "g3.16xlarge"
          • "g3s.xlarge"
          • "g4dn.xlarge"
          • "g4dn.2xlarge"
          • "g4dn.4xlarge"
          • "g4dn.8xlarge"
          • "g4dn.12xlarge"
          • "g4dn.16xlarge"
          • "g4dn.metal"
          • "cg1.4xlarge"
          • "p2.xlarge"
          • "p2.8xlarge"
          • "p2.16xlarge"
          • "p3.2xlarge"
          • "p3.8xlarge"
          • "p3.16xlarge"
          • "p3dn.24xlarge"
          • "d2.xlarge"
          • "d2.2xlarge"
          • "d2.4xlarge"
          • "d2.8xlarge"
          • "f1.2xlarge"
          • "f1.4xlarge"
          • "f1.16xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5.metal"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
          • "m5d.large"
          • "m5d.xlarge"
          • "m5d.2xlarge"
          • "m5d.4xlarge"
          • "m5d.8xlarge"
          • "m5d.12xlarge"
          • "m5d.16xlarge"
          • "m5d.24xlarge"
          • "m5d.metal"
          • "m5ad.large"
          • "m5ad.xlarge"
          • "m5ad.2xlarge"
          • "m5ad.4xlarge"
          • "m5ad.8xlarge"
          • "m5ad.12xlarge"
          • "m5ad.16xlarge"
          • "m5ad.24xlarge"
          • "h1.2xlarge"
          • "h1.4xlarge"
          • "h1.8xlarge"
          • "h1.16xlarge"
          • "z1d.large"
          • "z1d.xlarge"
          • "z1d.2xlarge"
          • "z1d.3xlarge"
          • "z1d.6xlarge"
          • "z1d.12xlarge"
          • "z1d.metal"
          • "u-6tb1.metal"
          • "u-9tb1.metal"
          • "u-12tb1.metal"
          • "u-18tb1.metal"
          • "u-24tb1.metal"
          • "a1.medium"
          • "a1.large"
          • "a1.xlarge"
          • "a1.2xlarge"
          • "a1.4xlarge"
          • "a1.metal"
          • "m5dn.large"
          • "m5dn.xlarge"
          • "m5dn.2xlarge"
          • "m5dn.4xlarge"
          • "m5dn.8xlarge"
          • "m5dn.12xlarge"
          • "m5dn.16xlarge"
          • "m5dn.24xlarge"
          • "m5n.large"
          • "m5n.xlarge"
          • "m5n.2xlarge"
          • "m5n.4xlarge"
          • "m5n.8xlarge"
          • "m5n.12xlarge"
          • "m5n.16xlarge"
          • "m5n.24xlarge"
          • "r5dn.large"
          • "r5dn.xlarge"
          • "r5dn.2xlarge"
          • "r5dn.4xlarge"
          • "r5dn.8xlarge"
          • "r5dn.12xlarge"
          • "r5dn.16xlarge"
          • "r5dn.24xlarge"
          • "r5n.large"
          • "r5n.xlarge"
          • "r5n.2xlarge"
          • "r5n.4xlarge"
          • "r5n.8xlarge"
          • "r5n.12xlarge"
          • "r5n.16xlarge"
          • "r5n.24xlarge"
          • "inf1.xlarge"
          • "inf1.2xlarge"
          • "inf1.6xlarge"
          • "inf1.24xlarge"
          • "m6g.metal"
          • "m6g.medium"
          • "m6g.large"
          • "m6g.xlarge"
          • "m6g.2xlarge"
          • "m6g.4xlarge"
          • "m6g.8xlarge"
          • "m6g.12xlarge"
          • "m6g.16xlarge"
          • "m6gd.metal"
          • "m6gd.medium"
          • "m6gd.large"
          • "m6gd.xlarge"
          • "m6gd.2xlarge"
          • "m6gd.4xlarge"
          • "m6gd.8xlarge"
          • "m6gd.12xlarge"
          • "m6gd.16xlarge"
        • MaxPrice — (String)

          The maximum price per unit hour that you are willing to pay for a Spot Instance.

        • SubnetId — (String)

          The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

        • AvailabilityZone — (String)

          The Availability Zone in which to launch the instances.

        • WeightedCapacity — (Float)

          The number of units provided by the specified instance type.

        • Priority — (Float)

          The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority.

        • Placement — (map)

          The location where the instance launched, if applicable.

          • AvailabilityZone — (String)

            The Availability Zone of the instance.

            If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

            This parameter is not supported by CreateFleet.

          • Affinity — (String)

            The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet.

          • GroupName — (String)

            The name of the placement group the instance is in.

          • PartitionNumber — (Integer)

            The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.

            This parameter is not supported by CreateFleet.

          • HostId — (String)

            The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet.

          • Tenancy — (String)

            The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet.

            Possible values include:
            • "default"
            • "dedicated"
            • "host"
          • SpreadDomain — (String)

            Reserved for future use.

            This parameter is not supported by CreateFleet.

          • HostResourceGroupArn — (String)

            The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

            This parameter is not supported by CreateFleet.

    • TargetCapacitySpecification — (map)

      The number of units to request.

      • TotalTargetCapacity — required — (Integer)

        The number of units to request, filled using DefaultTargetCapacityType.

      • OnDemandTargetCapacity — (Integer)

        The number of On-Demand units to request.

      • SpotTargetCapacity — (Integer)

        The number of Spot units to request.

      • DefaultTargetCapacityType — (String)

        The default TotalTargetCapacity, which is either Spot or On-Demand.

        Possible values include:
        • "spot"
        • "on-demand"
    • TerminateInstancesWithExpiration — (Boolean)

      Indicates whether running instances should be terminated when the EC2 Fleet expires.

    • Type — (String)

      The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.

      Possible values include:
      • "request"
      • "maintain"
      • "instant"
    • ValidFrom — (Date)

      The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

    • ValidUntil — (Date)

      The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

    • ReplaceUnhealthyInstances — (Boolean)

      Indicates whether EC2 Fleet should replace unhealthy instances.

    • TagSpecifications — (Array<map>)

      The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        The ID of the EC2 Fleet.

      • Errors — (Array<map>)

        Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

        • LaunchTemplateAndOverrides — (map)

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification — (map)

            The launch template.

            • LaunchTemplateId — (String)

              The ID of the launch template. If you specify the template ID, you can't specify the template name.

            • LaunchTemplateName — (String)

              The name of the launch template. If you specify the template name, you can't specify the template ID.

            • Version — (String)

              The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

              If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

              If the value is $Default, Amazon EC2 uses the default version of the launch template.

          • Overrides — (map)

            Any parameters that you specify override the same parameters in the launch template.

            • InstanceType — (String)

              The instance type.

              Possible values include:
              • "t1.micro"
              • "t2.nano"
              • "t2.micro"
              • "t2.small"
              • "t2.medium"
              • "t2.large"
              • "t2.xlarge"
              • "t2.2xlarge"
              • "t3.nano"
              • "t3.micro"
              • "t3.small"
              • "t3.medium"
              • "t3.large"
              • "t3.xlarge"
              • "t3.2xlarge"
              • "t3a.nano"
              • "t3a.micro"
              • "t3a.small"
              • "t3a.medium"
              • "t3a.large"
              • "t3a.xlarge"
              • "t3a.2xlarge"
              • "t4g.nano"
              • "t4g.micro"
              • "t4g.small"
              • "t4g.medium"
              • "t4g.large"
              • "t4g.xlarge"
              • "t4g.2xlarge"
              • "m1.small"
              • "m1.medium"
              • "m1.large"
              • "m1.xlarge"
              • "m3.medium"
              • "m3.large"
              • "m3.xlarge"
              • "m3.2xlarge"
              • "m4.large"
              • "m4.xlarge"
              • "m4.2xlarge"
              • "m4.4xlarge"
              • "m4.10xlarge"
              • "m4.16xlarge"
              • "m2.xlarge"
              • "m2.2xlarge"
              • "m2.4xlarge"
              • "cr1.8xlarge"
              • "r3.large"
              • "r3.xlarge"
              • "r3.2xlarge"
              • "r3.4xlarge"
              • "r3.8xlarge"
              • "r4.large"
              • "r4.xlarge"
              • "r4.2xlarge"
              • "r4.4xlarge"
              • "r4.8xlarge"
              • "r4.16xlarge"
              • "r5.large"
              • "r5.xlarge"
              • "r5.2xlarge"
              • "r5.4xlarge"
              • "r5.8xlarge"
              • "r5.12xlarge"
              • "r5.16xlarge"
              • "r5.24xlarge"
              • "r5.metal"
              • "r5a.large"
              • "r5a.xlarge"
              • "r5a.2xlarge"
              • "r5a.4xlarge"
              • "r5a.8xlarge"
              • "r5a.12xlarge"
              • "r5a.16xlarge"
              • "r5a.24xlarge"
              • "r5d.large"
              • "r5d.xlarge"
              • "r5d.2xlarge"
              • "r5d.4xlarge"
              • "r5d.8xlarge"
              • "r5d.12xlarge"
              • "r5d.16xlarge"
              • "r5d.24xlarge"
              • "r5d.metal"
              • "r5ad.large"
              • "r5ad.xlarge"
              • "r5ad.2xlarge"
              • "r5ad.4xlarge"
              • "r5ad.8xlarge"
              • "r5ad.12xlarge"
              • "r5ad.16xlarge"
              • "r5ad.24xlarge"
              • "r6g.metal"
              • "r6g.medium"
              • "r6g.large"
              • "r6g.xlarge"
              • "r6g.2xlarge"
              • "r6g.4xlarge"
              • "r6g.8xlarge"
              • "r6g.12xlarge"
              • "r6g.16xlarge"
              • "r6gd.metal"
              • "r6gd.medium"
              • "r6gd.large"
              • "r6gd.xlarge"
              • "r6gd.2xlarge"
              • "r6gd.4xlarge"
              • "r6gd.8xlarge"
              • "r6gd.12xlarge"
              • "r6gd.16xlarge"
              • "x1.16xlarge"
              • "x1.32xlarge"
              • "x1e.xlarge"
              • "x1e.2xlarge"
              • "x1e.4xlarge"
              • "x1e.8xlarge"
              • "x1e.16xlarge"
              • "x1e.32xlarge"
              • "i2.xlarge"
              • "i2.2xlarge"
              • "i2.4xlarge"
              • "i2.8xlarge"
              • "i3.large"
              • "i3.xlarge"
              • "i3.2xlarge"
              • "i3.4xlarge"
              • "i3.8xlarge"
              • "i3.16xlarge"
              • "i3.metal"
              • "i3en.large"
              • "i3en.xlarge"
              • "i3en.2xlarge"
              • "i3en.3xlarge"
              • "i3en.6xlarge"
              • "i3en.12xlarge"
              • "i3en.24xlarge"
              • "i3en.metal"
              • "hi1.4xlarge"
              • "hs1.8xlarge"
              • "c1.medium"
              • "c1.xlarge"
              • "c3.large"
              • "c3.xlarge"
              • "c3.2xlarge"
              • "c3.4xlarge"
              • "c3.8xlarge"
              • "c4.large"
              • "c4.xlarge"
              • "c4.2xlarge"
              • "c4.4xlarge"
              • "c4.8xlarge"
              • "c5.large"
              • "c5.xlarge"
              • "c5.2xlarge"
              • "c5.4xlarge"
              • "c5.9xlarge"
              • "c5.12xlarge"
              • "c5.18xlarge"
              • "c5.24xlarge"
              • "c5.metal"
              • "c5a.large"
              • "c5a.xlarge"
              • "c5a.2xlarge"
              • "c5a.4xlarge"
              • "c5a.8xlarge"
              • "c5a.12xlarge"
              • "c5a.16xlarge"
              • "c5a.24xlarge"
              • "c5ad.large"
              • "c5ad.xlarge"
              • "c5ad.2xlarge"
              • "c5ad.4xlarge"
              • "c5ad.8xlarge"
              • "c5ad.12xlarge"
              • "c5ad.16xlarge"
              • "c5ad.24xlarge"
              • "c5d.large"
              • "c5d.xlarge"
              • "c5d.2xlarge"
              • "c5d.4xlarge"
              • "c5d.9xlarge"
              • "c5d.12xlarge"
              • "c5d.18xlarge"
              • "c5d.24xlarge"
              • "c5d.metal"
              • "c5n.large"
              • "c5n.xlarge"
              • "c5n.2xlarge"
              • "c5n.4xlarge"
              • "c5n.9xlarge"
              • "c5n.18xlarge"
              • "c6g.metal"
              • "c6g.medium"
              • "c6g.large"
              • "c6g.xlarge"
              • "c6g.2xlarge"
              • "c6g.4xlarge"
              • "c6g.8xlarge"
              • "c6g.12xlarge"
              • "c6g.16xlarge"
              • "c6gd.metal"
              • "c6gd.medium"
              • "c6gd.large"
              • "c6gd.xlarge"
              • "c6gd.2xlarge"
              • "c6gd.4xlarge"
              • "c6gd.8xlarge"
              • "c6gd.12xlarge"
              • "c6gd.16xlarge"
              • "cc1.4xlarge"
              • "cc2.8xlarge"
              • "g2.2xlarge"
              • "g2.8xlarge"
              • "g3.4xlarge"
              • "g3.8xlarge"
              • "g3.16xlarge"
              • "g3s.xlarge"
              • "g4dn.xlarge"
              • "g4dn.2xlarge"
              • "g4dn.4xlarge"
              • "g4dn.8xlarge"
              • "g4dn.12xlarge"
              • "g4dn.16xlarge"
              • "g4dn.metal"
              • "cg1.4xlarge"
              • "p2.xlarge"
              • "p2.8xlarge"
              • "p2.16xlarge"
              • "p3.2xlarge"
              • "p3.8xlarge"
              • "p3.16xlarge"
              • "p3dn.24xlarge"
              • "d2.xlarge"
              • "d2.2xlarge"
              • "d2.4xlarge"
              • "d2.8xlarge"
              • "f1.2xlarge"
              • "f1.4xlarge"
              • "f1.16xlarge"
              • "m5.large"
              • "m5.xlarge"
              • "m5.2xlarge"
              • "m5.4xlarge"
              • "m5.8xlarge"
              • "m5.12xlarge"
              • "m5.16xlarge"
              • "m5.24xlarge"
              • "m5.metal"
              • "m5a.large"
              • "m5a.xlarge"
              • "m5a.2xlarge"
              • "m5a.4xlarge"
              • "m5a.8xlarge"
              • "m5a.12xlarge"
              • "m5a.16xlarge"
              • "m5a.24xlarge"
              • "m5d.large"
              • "m5d.xlarge"
              • "m5d.2xlarge"
              • "m5d.4xlarge"
              • "m5d.8xlarge"
              • "m5d.12xlarge"
              • "m5d.16xlarge"
              • "m5d.24xlarge"
              • "m5d.metal"
              • "m5ad.large"
              • "m5ad.xlarge"
              • "m5ad.2xlarge"
              • "m5ad.4xlarge"
              • "m5ad.8xlarge"
              • "m5ad.12xlarge"
              • "m5ad.16xlarge"
              • "m5ad.24xlarge"
              • "h1.2xlarge"
              • "h1.4xlarge"
              • "h1.8xlarge"
              • "h1.16xlarge"
              • "z1d.large"
              • "z1d.xlarge"
              • "z1d.2xlarge"
              • "z1d.3xlarge"
              • "z1d.6xlarge"
              • "z1d.12xlarge"
              • "z1d.metal"
              • "u-6tb1.metal"
              • "u-9tb1.metal"
              • "u-12tb1.metal"
              • "u-18tb1.metal"
              • "u-24tb1.metal"
              • "a1.medium"
              • "a1.large"
              • "a1.xlarge"
              • "a1.2xlarge"
              • "a1.4xlarge"
              • "a1.metal"
              • "m5dn.large"
              • "m5dn.xlarge"
              • "m5dn.2xlarge"
              • "m5dn.4xlarge"
              • "m5dn.8xlarge"
              • "m5dn.12xlarge"
              • "m5dn.16xlarge"
              • "m5dn.24xlarge"
              • "m5n.large"
              • "m5n.xlarge"
              • "m5n.2xlarge"
              • "m5n.4xlarge"
              • "m5n.8xlarge"
              • "m5n.12xlarge"
              • "m5n.16xlarge"
              • "m5n.24xlarge"
              • "r5dn.large"
              • "r5dn.xlarge"
              • "r5dn.2xlarge"
              • "r5dn.4xlarge"
              • "r5dn.8xlarge"
              • "r5dn.12xlarge"
              • "r5dn.16xlarge"
              • "r5dn.24xlarge"
              • "r5n.large"
              • "r5n.xlarge"
              • "r5n.2xlarge"
              • "r5n.4xlarge"
              • "r5n.8xlarge"
              • "r5n.12xlarge"
              • "r5n.16xlarge"
              • "r5n.24xlarge"
              • "inf1.xlarge"
              • "inf1.2xlarge"
              • "inf1.6xlarge"
              • "inf1.24xlarge"
              • "m6g.metal"
              • "m6g.medium"
              • "m6g.large"
              • "m6g.xlarge"
              • "m6g.2xlarge"
              • "m6g.4xlarge"
              • "m6g.8xlarge"
              • "m6g.12xlarge"
              • "m6g.16xlarge"
              • "m6gd.metal"
              • "m6gd.medium"
              • "m6gd.large"
              • "m6gd.xlarge"
              • "m6gd.2xlarge"
              • "m6gd.4xlarge"
              • "m6gd.8xlarge"
              • "m6gd.12xlarge"
              • "m6gd.16xlarge"
            • MaxPrice — (String)

              The maximum price per unit hour that you are willing to pay for a Spot Instance.

            • SubnetId — (String)

              The ID of the subnet in which to launch the instances.

            • AvailabilityZone — (String)

              The Availability Zone in which to launch the instances.

            • WeightedCapacity — (Float)

              The number of units provided by the specified instance type.

            • Priority — (Float)

              The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

            • Placement — (map)

              The location where the instance launched, if applicable.

              • GroupName — (String)

                The name of the placement group that the instance is in.

        • Lifecycle — (String)

          Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

          Possible values include:
          • "spot"
          • "on-demand"
        • ErrorCode — (String)

          The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.

        • ErrorMessage — (String)

          The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes.

      • Instances — (Array<map>)

        Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

        • LaunchTemplateAndOverrides — (map)

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification — (map)

            The launch template.

            • LaunchTemplateId — (String)

              The ID of the launch template. If you specify the template ID, you can't specify the template name.

            • LaunchTemplateName — (String)

              The name of the launch template. If you specify the template name, you can't specify the template ID.

            • Version — (String)

              The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

              If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

              If the value is $Default, Amazon EC2 uses the default version of the launch template.

          • Overrides — (map)

            Any parameters that you specify override the same parameters in the launch template.

            • InstanceType — (String)

              The instance type.

              Possible values include:
              • "t1.micro"
              • "t2.nano"
              • "t2.micro"
              • "t2.small"
              • "t2.medium"
              • "t2.large"
              • "t2.xlarge"
              • "t2.2xlarge"
              • "t3.nano"
              • "t3.micro"
              • "t3.small"
              • "t3.medium"
              • "t3.large"
              • "t3.xlarge"
              • "t3.2xlarge"
              • "t3a.nano"
              • "t3a.micro"
              • "t3a.small"
              • "t3a.medium"
              • "t3a.large"
              • "t3a.xlarge"
              • "t3a.2xlarge"
              • "t4g.nano"
              • "t4g.micro"
              • "t4g.small"
              • "t4g.medium"
              • "t4g.large"
              • "t4g.xlarge"
              • "t4g.2xlarge"
              • "m1.small"
              • "m1.medium"
              • "m1.large"
              • "m1.xlarge"
              • "m3.medium"
              • "m3.large"
              • "m3.xlarge"
              • "m3.2xlarge"
              • "m4.large"
              • "m4.xlarge"
              • "m4.2xlarge"
              • "m4.4xlarge"
              • "m4.10xlarge"
              • "m4.16xlarge"
              • "m2.xlarge"
              • "m2.2xlarge"
              • "m2.4xlarge"
              • "cr1.8xlarge"
              • "r3.large"
              • "r3.xlarge"
              • "r3.2xlarge"
              • "r3.4xlarge"
              • "r3.8xlarge"
              • "r4.large"
              • "r4.xlarge"
              • "r4.2xlarge"
              • "r4.4xlarge"
              • "r4.8xlarge"
              • "r4.16xlarge"
              • "r5.large"
              • "r5.xlarge"
              • "r5.2xlarge"
              • "r5.4xlarge"
              • "r5.8xlarge"
              • "r5.12xlarge"
              • "r5.16xlarge"
              • "r5.24xlarge"
              • "r5.metal"
              • "r5a.large"
              • "r5a.xlarge"
              • "r5a.2xlarge"
              • "r5a.4xlarge"
              • "r5a.8xlarge"
              • "r5a.12xlarge"
              • "r5a.16xlarge"
              • "r5a.24xlarge"
              • "r5d.large"
              • "r5d.xlarge"
              • "r5d.2xlarge"
              • "r5d.4xlarge"
              • "r5d.8xlarge"
              • "r5d.12xlarge"
              • "r5d.16xlarge"
              • "r5d.24xlarge"
              • "r5d.metal"
              • "r5ad.large"
              • "r5ad.xlarge"
              • "r5ad.2xlarge"
              • "r5ad.4xlarge"
              • "r5ad.8xlarge"
              • "r5ad.12xlarge"
              • "r5ad.16xlarge"
              • "r5ad.24xlarge"
              • "r6g.metal"
              • "r6g.medium"
              • "r6g.large"
              • "r6g.xlarge"
              • "r6g.2xlarge"
              • "r6g.4xlarge"
              • "r6g.8xlarge"
              • "r6g.12xlarge"
              • "r6g.16xlarge"
              • "r6gd.metal"
              • "r6gd.medium"
              • "r6gd.large"
              • "r6gd.xlarge"
              • "r6gd.2xlarge"
              • "r6gd.4xlarge"
              • "r6gd.8xlarge"
              • "r6gd.12xlarge"
              • "r6gd.16xlarge"
              • "x1.16xlarge"
              • "x1.32xlarge"
              • "x1e.xlarge"
              • "x1e.2xlarge"
              • "x1e.4xlarge"
              • "x1e.8xlarge"
              • "x1e.16xlarge"
              • "x1e.32xlarge"
              • "i2.xlarge"
              • "i2.2xlarge"
              • "i2.4xlarge"
              • "i2.8xlarge"
              • "i3.large"
              • "i3.xlarge"
              • "i3.2xlarge"
              • "i3.4xlarge"
              • "i3.8xlarge"
              • "i3.16xlarge"
              • "i3.metal"
              • "i3en.large"
              • "i3en.xlarge"
              • "i3en.2xlarge"
              • "i3en.3xlarge"
              • "i3en.6xlarge"
              • "i3en.12xlarge"
              • "i3en.24xlarge"
              • "i3en.metal"
              • "hi1.4xlarge"
              • "hs1.8xlarge"
              • "c1.medium"
              • "c1.xlarge"
              • "c3.large"
              • "c3.xlarge"
              • "c3.2xlarge"
              • "c3.4xlarge"
              • "c3.8xlarge"
              • "c4.large"
              • "c4.xlarge"
              • "c4.2xlarge"
              • "c4.4xlarge"
              • "c4.8xlarge"
              • "c5.large"
              • "c5.xlarge"
              • "c5.2xlarge"
              • "c5.4xlarge"
              • "c5.9xlarge"
              • "c5.12xlarge"
              • "c5.18xlarge"
              • "c5.24xlarge"
              • "c5.metal"
              • "c5a.large"
              • "c5a.xlarge"
              • "c5a.2xlarge"
              • "c5a.4xlarge"
              • "c5a.8xlarge"
              • "c5a.12xlarge"
              • "c5a.16xlarge"
              • "c5a.24xlarge"
              • "c5ad.large"
              • "c5ad.xlarge"
              • "c5ad.2xlarge"
              • "c5ad.4xlarge"
              • "c5ad.8xlarge"
              • "c5ad.12xlarge"
              • "c5ad.16xlarge"
              • "c5ad.24xlarge"
              • "c5d.large"
              • "c5d.xlarge"
              • "c5d.2xlarge"
              • "c5d.4xlarge"
              • "c5d.9xlarge"
              • "c5d.12xlarge"
              • "c5d.18xlarge"
              • "c5d.24xlarge"
              • "c5d.metal"
              • "c5n.large"
              • "c5n.xlarge"
              • "c5n.2xlarge"
              • "c5n.4xlarge"
              • "c5n.9xlarge"
              • "c5n.18xlarge"
              • "c6g.metal"
              • "c6g.medium"
              • "c6g.large"
              • "c6g.xlarge"
              • "c6g.2xlarge"
              • "c6g.4xlarge"
              • "c6g.8xlarge"
              • "c6g.12xlarge"
              • "c6g.16xlarge"
              • "c6gd.metal"
              • "c6gd.medium"
              • "c6gd.large"
              • "c6gd.xlarge"
              • "c6gd.2xlarge"
              • "c6gd.4xlarge"
              • "c6gd.8xlarge"
              • "c6gd.12xlarge"
              • "c6gd.16xlarge"
              • "cc1.4xlarge"
              • "cc2.8xlarge"
              • "g2.2xlarge"
              • "g2.8xlarge"
              • "g3.4xlarge"
              • "g3.8xlarge"
              • "g3.16xlarge"
              • "g3s.xlarge"
              • "g4dn.xlarge"
              • "g4dn.2xlarge"
              • "g4dn.4xlarge"
              • "g4dn.8xlarge"
              • "g4dn.12xlarge"
              • "g4dn.16xlarge"
              • "g4dn.metal"
              • "cg1.4xlarge"
              • "p2.xlarge"
              • "p2.8xlarge"
              • "p2.16xlarge"
              • "p3.2xlarge"
              • "p3.8xlarge"
              • "p3.16xlarge"
              • "p3dn.24xlarge"
              • "d2.xlarge"
              • "d2.2xlarge"
              • "d2.4xlarge"
              • "d2.8xlarge"
              • "f1.2xlarge"
              • "f1.4xlarge"
              • "f1.16xlarge"
              • "m5.large"
              • "m5.xlarge"
              • "m5.2xlarge"
              • "m5.4xlarge"
              • "m5.8xlarge"
              • "m5.12xlarge"
              • "m5.16xlarge"
              • "m5.24xlarge"
              • "m5.metal"
              • "m5a.large"
              • "m5a.xlarge"
              • "m5a.2xlarge"
              • "m5a.4xlarge"
              • "m5a.8xlarge"
              • "m5a.12xlarge"
              • "m5a.16xlarge"
              • "m5a.24xlarge"
              • "m5d.large"
              • "m5d.xlarge"
              • "m5d.2xlarge"
              • "m5d.4xlarge"
              • "m5d.8xlarge"
              • "m5d.12xlarge"
              • "m5d.16xlarge"
              • "m5d.24xlarge"
              • "m5d.metal"
              • "m5ad.large"
              • "m5ad.xlarge"
              • "m5ad.2xlarge"
              • "m5ad.4xlarge"
              • "m5ad.8xlarge"
              • "m5ad.12xlarge"
              • "m5ad.16xlarge"
              • "m5ad.24xlarge"
              • "h1.2xlarge"
              • "h1.4xlarge"
              • "h1.8xlarge"
              • "h1.16xlarge"
              • "z1d.large"
              • "z1d.xlarge"
              • "z1d.2xlarge"
              • "z1d.3xlarge"
              • "z1d.6xlarge"
              • "z1d.12xlarge"
              • "z1d.metal"
              • "u-6tb1.metal"
              • "u-9tb1.metal"
              • "u-12tb1.metal"
              • "u-18tb1.metal"
              • "u-24tb1.metal"
              • "a1.medium"
              • "a1.large"
              • "a1.xlarge"
              • "a1.2xlarge"
              • "a1.4xlarge"
              • "a1.metal"
              • "m5dn.large"
              • "m5dn.xlarge"
              • "m5dn.2xlarge"
              • "m5dn.4xlarge"
              • "m5dn.8xlarge"
              • "m5dn.12xlarge"
              • "m5dn.16xlarge"
              • "m5dn.24xlarge"
              • "m5n.large"
              • "m5n.xlarge"
              • "m5n.2xlarge"
              • "m5n.4xlarge"
              • "m5n.8xlarge"
              • "m5n.12xlarge"
              • "m5n.16xlarge"
              • "m5n.24xlarge"
              • "r5dn.large"
              • "r5dn.xlarge"
              • "r5dn.2xlarge"
              • "r5dn.4xlarge"
              • "r5dn.8xlarge"
              • "r5dn.12xlarge"
              • "r5dn.16xlarge"
              • "r5dn.24xlarge"
              • "r5n.large"
              • "r5n.xlarge"
              • "r5n.2xlarge"
              • "r5n.4xlarge"
              • "r5n.8xlarge"
              • "r5n.12xlarge"
              • "r5n.16xlarge"
              • "r5n.24xlarge"
              • "inf1.xlarge"
              • "inf1.2xlarge"
              • "inf1.6xlarge"
              • "inf1.24xlarge"
              • "m6g.metal"
              • "m6g.medium"
              • "m6g.large"
              • "m6g.xlarge"
              • "m6g.2xlarge"
              • "m6g.4xlarge"
              • "m6g.8xlarge"
              • "m6g.12xlarge"
              • "m6g.16xlarge"
              • "m6gd.metal"
              • "m6gd.medium"
              • "m6gd.large"
              • "m6gd.xlarge"
              • "m6gd.2xlarge"
              • "m6gd.4xlarge"
              • "m6gd.8xlarge"
              • "m6gd.12xlarge"
              • "m6gd.16xlarge"
            • MaxPrice — (String)

              The maximum price per unit hour that you are willing to pay for a Spot Instance.

            • SubnetId — (String)

              The ID of the subnet in which to launch the instances.

            • AvailabilityZone — (String)

              The Availability Zone in which to launch the instances.

            • WeightedCapacity — (Float)

              The number of units provided by the specified instance type.

            • Priority — (Float)

              The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

            • Placement — (map)

              The location where the instance launched, if applicable.

              • GroupName — (String)

                The name of the placement group that the instance is in.

        • Lifecycle — (String)

          Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

          Possible values include:
          • "spot"
          • "on-demand"
        • InstanceIds — (Array<String>)

          The IDs of the instances.

        • InstanceType — (String)

          The instance type.

          Possible values include:
          • "t1.micro"
          • "t2.nano"
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "t2.xlarge"
          • "t2.2xlarge"
          • "t3.nano"
          • "t3.micro"
          • "t3.small"
          • "t3.medium"
          • "t3.large"
          • "t3.xlarge"
          • "t3.2xlarge"
          • "t3a.nano"
          • "t3a.micro"
          • "t3a.small"
          • "t3a.medium"
          • "t3a.large"
          • "t3a.xlarge"
          • "t3a.2xlarge"
          • "t4g.nano"
          • "t4g.micro"
          • "t4g.small"
          • "t4g.medium"
          • "t4g.large"
          • "t4g.xlarge"
          • "t4g.2xlarge"
          • "m1.small"
          • "m1.medium"
          • "m1.large"
          • "m1.xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m4.16xlarge"
          • "m2.xlarge"
          • "m2.2xlarge"
          • "m2.4xlarge"
          • "cr1.8xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5.metal"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "r5d.large"
          • "r5d.xlarge"
          • "r5d.2xlarge"
          • "r5d.4xlarge"
          • "r5d.8xlarge"
          • "r5d.12xlarge"
          • "r5d.16xlarge"
          • "r5d.24xlarge"
          • "r5d.metal"
          • "r5ad.large"
          • "r5ad.xlarge"
          • "r5ad.2xlarge"
          • "r5ad.4xlarge"
          • "r5ad.8xlarge"
          • "r5ad.12xlarge"
          • "r5ad.16xlarge"
          • "r5ad.24xlarge"
          • "r6g.metal"
          • "r6g.medium"
          • "r6g.large"
          • "r6g.xlarge"
          • "r6g.2xlarge"
          • "r6g.4xlarge"
          • "r6g.8xlarge"
          • "r6g.12xlarge"
          • "r6g.16xlarge"
          • "r6gd.metal"
          • "r6gd.medium"
          • "r6gd.large"
          • "r6gd.xlarge"
          • "r6gd.2xlarge"
          • "r6gd.4xlarge"
          • "r6gd.8xlarge"
          • "r6gd.12xlarge"
          • "r6gd.16xlarge"
          • "x1.16xlarge"
          • "x1.32xlarge"
          • "x1e.xlarge"
          • "x1e.2xlarge"
          • "x1e.4xlarge"
          • "x1e.8xlarge"
          • "x1e.16xlarge"
          • "x1e.32xlarge"
          • "i2.xlarge"
          • "i2.2xlarge"
          • "i2.4xlarge"
          • "i2.8xlarge"
          • "i3.large"
          • "i3.xlarge"
          • "i3.2xlarge"
          • "i3.4xlarge"
          • "i3.8xlarge"
          • "i3.16xlarge"
          • "i3.metal"
          • "i3en.large"
          • "i3en.xlarge"
          • "i3en.2xlarge"
          • "i3en.3xlarge"
          • "i3en.6xlarge"
          • "i3en.12xlarge"
          • "i3en.24xlarge"
          • "i3en.metal"
          • "hi1.4xlarge"
          • "hs1.8xlarge"
          • "c1.medium"
          • "c1.xlarge"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5.metal"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "c5ad.large"
          • "c5ad.xlarge"
          • "c5ad.2xlarge"
          • "c5ad.4xlarge"
          • "c5ad.8xlarge"
          • "c5ad.12xlarge"
          • "c5ad.16xlarge"
          • "c5ad.24xlarge"
          • "c5d.large"
          • "c5d.xlarge"
          • "c5d.2xlarge"
          • "c5d.4xlarge"
          • "c5d.9xlarge"
          • "c5d.12xlarge"
          • "c5d.18xlarge"
          • "c5d.24xlarge"
          • "c5d.metal"
          • "c5n.large"
          • "c5n.xlarge"
          • "c5n.2xlarge"
          • "c5n.4xlarge"
          • "c5n.9xlarge"
          • "c5n.18xlarge"
          • "c6g.metal"
          • "c6g.medium"
          • "c6g.large"
          • "c6g.xlarge"
          • "c6g.2xlarge"
          • "c6g.4xlarge"
          • "c6g.8xlarge"
          • "c6g.12xlarge"
          • "c6g.16xlarge"
          • "c6gd.metal"
          • "c6gd.medium"
          • "c6gd.large"
          • "c6gd.xlarge"
          • "c6gd.2xlarge"
          • "c6gd.4xlarge"
          • "c6gd.8xlarge"
          • "c6gd.12xlarge"
          • "c6gd.16xlarge"
          • "cc1.4xlarge"
          • "cc2.8xlarge"
          • "g2.2xlarge"
          • "g2.8xlarge"
          • "g3.4xlarge"
          • "g3.8xlarge"
          • "g3.16xlarge"
          • "g3s.xlarge"
          • "g4dn.xlarge"
          • "g4dn.2xlarge"
          • "g4dn.4xlarge"
          • "g4dn.8xlarge"
          • "g4dn.12xlarge"
          • "g4dn.16xlarge"
          • "g4dn.metal"
          • "cg1.4xlarge"
          • "p2.xlarge"
          • "p2.8xlarge"
          • "p2.16xlarge"
          • "p3.2xlarge"
          • "p3.8xlarge"
          • "p3.16xlarge"
          • "p3dn.24xlarge"
          • "d2.xlarge"
          • "d2.2xlarge"
          • "d2.4xlarge"
          • "d2.8xlarge"
          • "f1.2xlarge"
          • "f1.4xlarge"
          • "f1.16xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5.metal"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
          • "m5d.large"
          • "m5d.xlarge"
          • "m5d.2xlarge"
          • "m5d.4xlarge"
          • "m5d.8xlarge"
          • "m5d.12xlarge"
          • "m5d.16xlarge"
          • "m5d.24xlarge"
          • "m5d.metal"
          • "m5ad.large"
          • "m5ad.xlarge"
          • "m5ad.2xlarge"
          • "m5ad.4xlarge"
          • "m5ad.8xlarge"
          • "m5ad.12xlarge"
          • "m5ad.16xlarge"
          • "m5ad.24xlarge"
          • "h1.2xlarge"
          • "h1.4xlarge"
          • "h1.8xlarge"
          • "h1.16xlarge"
          • "z1d.large"
          • "z1d.xlarge"
          • "z1d.2xlarge"
          • "z1d.3xlarge"
          • "z1d.6xlarge"
          • "z1d.12xlarge"
          • "z1d.metal"
          • "u-6tb1.metal"
          • "u-9tb1.metal"
          • "u-12tb1.metal"
          • "u-18tb1.metal"
          • "u-24tb1.metal"
          • "a1.medium"
          • "a1.large"
          • "a1.xlarge"
          • "a1.2xlarge"
          • "a1.4xlarge"
          • "a1.metal"
          • "m5dn.large"
          • "m5dn.xlarge"
          • "m5dn.2xlarge"
          • "m5dn.4xlarge"
          • "m5dn.8xlarge"
          • "m5dn.12xlarge"
          • "m5dn.16xlarge"
          • "m5dn.24xlarge"
          • "m5n.large"
          • "m5n.xlarge"
          • "m5n.2xlarge"
          • "m5n.4xlarge"
          • "m5n.8xlarge"
          • "m5n.12xlarge"
          • "m5n.16xlarge"
          • "m5n.24xlarge"
          • "r5dn.large"
          • "r5dn.xlarge"
          • "r5dn.2xlarge"
          • "r5dn.4xlarge"
          • "r5dn.8xlarge"
          • "r5dn.12xlarge"
          • "r5dn.16xlarge"
          • "r5dn.24xlarge"
          • "r5n.large"
          • "r5n.xlarge"
          • "r5n.2xlarge"
          • "r5n.4xlarge"
          • "r5n.8xlarge"
          • "r5n.12xlarge"
          • "r5n.16xlarge"
          • "r5n.24xlarge"
          • "inf1.xlarge"
          • "inf1.2xlarge"
          • "inf1.6xlarge"
          • "inf1.24xlarge"
          • "m6g.metal"
          • "m6g.medium"
          • "m6g.large"
          • "m6g.xlarge"
          • "m6g.2xlarge"
          • "m6g.4xlarge"
          • "m6g.8xlarge"
          • "m6g.12xlarge"
          • "m6g.16xlarge"
          • "m6gd.metal"
          • "m6gd.medium"
          • "m6gd.large"
          • "m6gd.xlarge"
          • "m6gd.2xlarge"
          • "m6gd.4xlarge"
          • "m6gd.8xlarge"
          • "m6gd.12xlarge"
          • "m6gd.16xlarge"
        • Platform — (String)

          The value is Windows for Windows instances. Otherwise, the value is blank.

          Possible values include:
          • "Windows"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFlowLogs(params = {}, callback) ⇒ AWS.Request

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

Calling the createFlowLogs operation

var params = {
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: VPC | Subnet | NetworkInterface, /* required */
  TrafficType: ACCEPT | REJECT | ALL, /* required */
  ClientToken: 'STRING_VALUE',
  DeliverLogsPermissionArn: 'STRING_VALUE',
  DryRun: true || false,
  LogDestination: 'STRING_VALUE',
  LogDestinationType: cloud-watch-logs | s3,
  LogFormat: 'STRING_VALUE',
  LogGroupName: 'STRING_VALUE',
  MaxAggregationInterval: 'NUMBER_VALUE',
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createFlowLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

    • DeliverLogsPermissionArn — (String)

      The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

      If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

    • LogGroupName — (String)

      The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

      If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

    • ResourceIds — (Array<String>)

      The ID of the subnet, network interface, or VPC for which you want to create a flow log.

      Constraints: Maximum of 1000 resources

    • ResourceType — (String)

      The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

      Possible values include:
      • "VPC"
      • "Subnet"
      • "NetworkInterface"
    • TrafficType — (String)

      The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

      Possible values include:
      • "ACCEPT"
      • "REJECT"
      • "ALL"
    • LogDestinationType — (String)

      Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

      If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

      Default: cloud-watch-logs

      Possible values include:
      • "cloud-watch-logs"
      • "s3"
    • LogDestination — (String)

      Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

      If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

      If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

    • LogFormat — (String)

      The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

      Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

    • TagSpecifications — (Array<map>)

      The tags to apply to the flow logs.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • MaxAggregationInterval — (Integer)

      The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

      When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

      Default: 600

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      • FlowLogIds — (Array<String>)

        The IDs of the flow logs.

      • Unsuccessful — (Array<map>)

        Information about the flow logs that could not be created successfully.

        • Error — (map)

          Information about the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message accompanying the error code.

        • ResourceId — (String)

          The ID of the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFpgaImage(params = {}, callback) ⇒ AWS.Request

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.

Service Reference:

Examples:

Calling the createFpgaImage operation

var params = {
  InputStorageLocation: { /* required */
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  LogsStorageLocation: {
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createFpgaImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • InputStorageLocation — (map)

      The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

      • Bucket — (String)

        The name of the S3 bucket.

      • Key — (String)

        The key.

    • LogsStorageLocation — (map)

      The location in Amazon S3 for the output logs.

      • Bucket — (String)

        The name of the S3 bucket.

      • Key — (String)

        The key.

    • Description — (String)

      A description for the AFI.

    • Name — (String)

      A name for the AFI.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    • TagSpecifications — (Array<map>)

      The tags to apply to the FPGA image during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImageId — (String)

        The FPGA image identifier (AFI ID).

      • FpgaImageGlobalId — (String)

        The global FPGA image identifier (AGFI ID).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createImage(params = {}, callback) ⇒ AWS.Request

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create an AMI from an Amazon EBS-backed instance


/* This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc. */

 var params = {
  BlockDeviceMappings: [
     {
    DeviceName: "/dev/sdh", 
    Ebs: {
     VolumeSize: 100
    }
   }, 
     {
    DeviceName: "/dev/sdc", 
    VirtualName: "ephemeral1"
   }
  ], 
  Description: "An AMI for my server", 
  InstanceId: "i-1234567890abcdef0", 
  Name: "My server", 
  NoReboot: true
 };
 ec2.createImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImageId: "ami-1a2b3c4d"
   }
   */
 });

Calling the createImage operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  BlockDeviceMappings: [
    {
      DeviceName: 'STRING_VALUE',
      Ebs: {
        DeleteOnTermination: true || false,
        Encrypted: true || false,
        Iops: 'NUMBER_VALUE',
        KmsKeyId: 'STRING_VALUE',
        SnapshotId: 'STRING_VALUE',
        VolumeSize: 'NUMBER_VALUE',
        VolumeType: standard | io1 | io2 | gp2 | sc1 | st1
      },
      NoDevice: 'STRING_VALUE',
      VirtualName: 'STRING_VALUE'
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  DryRun: true || false,
  NoReboot: true || false
};
ec2.createImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BlockDeviceMappings — (Array<map>)

      The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

      • DeviceName — (String)

        The device name (for example, /dev/sdh or xvdh).

      • VirtualName — (String)

        The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

        NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

      • Ebs — (map)

        Parameters used to automatically set up EBS volumes when the instance is launched.

        • DeleteOnTermination — (Boolean)

          Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon Elastic Compute Cloud User Guide.

        • Iops — (Integer)

          The number of I/O operations per second (IOPS) that the volume supports. For io1 and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

          Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000 IOPS for io1 and io2 volumes in most Regions. Maximum io1 and io2 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

          Condition: This parameter is required for requests to create io1 and io2 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

        • SnapshotId — (String)

          The ID of the snapshot.

        • VolumeSize — (Integer)

          The size of the volume, in GiB.

          Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

          Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1 and io2), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

        • VolumeType — (String)

          The volume type. If you set the type to io1 or io2, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

          Default: gp2

          Possible values include:
          • "standard"
          • "io1"
          • "io2"
          • "gp2"
          • "sc1"
          • "st1"
        • KmsKeyId — (String)

          Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

          This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

        • Encrypted — (Boolean)

          Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

          In no case can you remove encryption from an encrypted volume.

          Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

          This parameter is not returned by .

      • NoDevice — (String)

        Suppresses the specified device included in the block device mapping of the AMI.

    • Description — (String)

      A description for the new image.

    • DryRun — (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.

    • InstanceId — (String)

      The ID of the instance.

    • Name — (String)

      A name for the new image.

      Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

    • NoReboot — (Boolean)

      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageId — (String)

        The ID of the new AMI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInstanceExportTask(params = {}, callback) ⇒ AWS.Request

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

Service Reference:

Examples:

Calling the createInstanceExportTask operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ExportToS3Task: {
    ContainerFormat: ova,
    DiskImageFormat: VMDK | RAW | VHD,
    S3Bucket: 'STRING_VALUE',
    S3Prefix: 'STRING_VALUE'
  },
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TargetEnvironment: citrix | vmware | microsoft
};
ec2.createInstanceExportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for the conversion task or the resource being exported. The maximum length is 255 characters.

    • ExportToS3Task — (map)

      The format and location for an instance export task.

      • ContainerFormat — (String)

        The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

        Possible values include:
        • "ova"
      • DiskImageFormat — (String)

        The format for the exported image.

        Possible values include:
        • "VMDK"
        • "RAW"
        • "VHD"
      • S3Bucket — (String)

        The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

      • S3Prefix — (String)

        The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

    • InstanceId — (String)

      The ID of the instance.

    • TargetEnvironment — (String)

      The target virtualization environment.

      Possible values include:
      • "citrix"
      • "vmware"
      • "microsoft"
    • TagSpecifications — (Array<map>)

      The tags to apply to the instance export task during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportTask — (map)

        Information about the instance export task.

        • Description — (String)

          A description of the resource being exported.

        • ExportTaskId — (String)

          The ID of the export task.

        • ExportToS3Task — (map)

          Information about the export task.

          • ContainerFormat — (String)

            The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

            Possible values include:
            • "ova"
          • DiskImageFormat — (String)

            The format for the exported image.

            Possible values include:
            • "VMDK"
            • "RAW"
            • "VHD"
          • S3Bucket — (String)

            The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

          • S3Key — (String)

            The encryption key for your S3 bucket.

        • InstanceExportDetails — (map)

          Information about the instance to export.

          • InstanceId — (String)

            The ID of the resource being exported.

          • TargetEnvironment — (String)

            The target virtualization environment.

            Possible values include:
            • "citrix"
            • "vmware"
            • "microsoft"
        • State — (String)

          The state of the export task.

          Possible values include:
          • "active"
          • "cancelling"
          • "cancelled"
          • "completed"
        • StatusMessage — (String)

          The status message related to the export task.

        • Tags — (Array<map>)

          The tags for the export task.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInternetGateway(params = {}, callback) ⇒ AWS.Request

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To create an Internet gateway


/* This example creates an Internet gateway. */

 var params = {
 };
 ec2.createInternetGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InternetGateway: {
     Attachments: [
     ], 
     InternetGatewayId: "igw-c0a643a9", 
     Tags: [
     ]
    }
   }
   */
 });

Calling the createInternetGateway operation

var params = {
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TagSpecifications — (Array<map>)

      The tags to assign to the internet gateway.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InternetGateway — (map)

        Information about the internet gateway.

        • Attachments — (Array<map>)

          Any VPCs attached to the internet gateway.

          • State — (String)

            The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • InternetGatewayId — (String)

          The ID of the internet gateway.

        • OwnerId — (String)

          The ID of the AWS account that owns the internet gateway.

        • Tags — (Array<map>)

          Any tags assigned to the internet gateway.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createKeyPair(params = {}, callback) ⇒ AWS.Request

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per Region.

The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create a key pair


/* This example creates a key pair named my-key-pair. */

 var params = {
  KeyName: "my-key-pair"
 };
 ec2.createKeyPair(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createKeyPair operation

var params = {
  KeyName: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • KeyName — (String)

      A unique name for the key pair.

      Constraints: Up to 255 ASCII characters

    • DryRun — (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.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new key pair.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyFingerprint — (String)

        The SHA-1 digest of the DER encoded private key.

      • KeyMaterial — (String)

        An unencrypted PEM encoded RSA private key.

      • KeyName — (String)

        The name of the key pair.

      • KeyPairId — (String)

        The ID of the key pair.

      • Tags — (Array<map>)

        Any tags applied to the key pair.

        • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLaunchTemplate(params = {}, callback) ⇒ AWS.Request

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create a launch template


/* This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance. */

 var params = {
  LaunchTemplateData: {
   ImageId: "ami-8c1be5f6", 
   InstanceType: "t2.small", 
   NetworkInterfaces: [
      {
     AssociatePublicIpAddress: true, 
     DeviceIndex: 0, 
     Ipv6AddressCount: 1, 
     SubnetId: "subnet-7b16de0c"
    }
   ], 
   TagSpecifications: [
      {
     ResourceType: "instance", 
     Tags: [
        {
       Key: "Name", 
       Value: "webserver"
      }
     ]
    }
   ]
  }, 
  LaunchTemplateName: "my-template", 
  VersionDescription: "WebVersion1"
 };
 ec2.createLaunchTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplate: {
     CreateTime: <Date Representation>, 
     CreatedBy: "arn:aws:iam::123456789012:root", 
     DefaultVersionNumber: 1, 
     LatestVersionNumber: 1, 
     LaunchTemplateId: "lt-01238c059e3466abc", 
     LaunchTemplateName: "my-template"
    }
   }
   */
 });

Calling the createLaunchTemplate operation

var params = {
  LaunchTemplateData: { /* required */
    BlockDeviceMappings: [
      {
        DeviceName: 'STRING_VALUE',
        Ebs: {
          DeleteOnTermination: true || false,
          Encrypted: true || false,
          Iops: 'NUMBER_VALUE',
          KmsKeyId: 'STRING_VALUE',
          SnapshotId: 'STRING_VALUE',
          VolumeSize: 'NUMBER_VALUE',
          VolumeType: standard | io1 | io2 | gp2 | sc1 | st1
        },
        NoDevice: 'STRING_VALUE',
        VirtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    CapacityReservationSpecification: {
      CapacityReservationPreference: open | none,
      CapacityReservationTarget: {
        CapacityReservationId: 'STRING_VALUE',
        CapacityReservationResourceGroupArn: 'STRING_VALUE'
      }
    },
    CpuOptions: {
      CoreCount: 'NUMBER_VALUE',
      ThreadsPerCore: 'NUMBER_VALUE'
    },
    CreditSpecification: {
      CpuCredits: 'STRING_VALUE' /* required */
    },
    DisableApiTermination: true || false,
    EbsOptimized: true || false,
    ElasticGpuSpecifications: [
      {
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ElasticInferenceAccelerators: [
      {
        Type: 'STRING_VALUE', /* required */
        Count: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    HibernationOptions: {
      Configured: true || false
    },
    IamInstanceProfile: {
      Arn: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    },
    ImageId: 'STRING_VALUE',
    InstanceInitiatedShutdownBehavior: stop | terminate,
    InstanceMarketOptions: {
      MarketType: spot,
      SpotOptions: {
        BlockDurationMinutes: 'NUMBER_VALUE',
        InstanceInterruptionBehavior: hibernate | stop | terminate,
        MaxPrice: 'STRING_VALUE',
        SpotInstanceType: one-time | persistent,
        ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      }
    },
    InstanceType: t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r6g.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6gd.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | hi1.4xlarge | hs1.8xlarge | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c6g.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6gd.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | cc1.4xlarge | cc2.8xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | cg1.4xlarge | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge,
    KernelId: 'STRING_VALUE',
    KeyName: 'STRING_VALUE',
    LicenseSpecifications: [
      {
        LicenseConfigurationArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    MetadataOptions: {
      HttpEndpoint: disabled | enabled,
      HttpPutResponseHopLimit: 'NUMBER_VALUE',
      HttpTokens: optional | required
    },
    Monitoring: {
      Enabled: true || false
    },
    NetworkInterfaces: [
      {
        AssociateCarrierIpAddress: true || false,
        AssociatePublicIpAddress: true || false,
        DeleteOnTermination: true || false,
        Description: 'STRING_VALUE',
        DeviceIndex: 'NUMBER_VALUE',
        Groups: [
          'STRING_VALUE',
          /* more items */
        ],
        InterfaceType: 'STRING_VALUE',
        Ipv6AddressCount: 'NUMBER_VALUE',
        Ipv6Addresses: [
          {
            Ipv6Address: 'STRING_VALUE'
          },
          /* more items */
        ],
        NetworkInterfaceId: 'STRING_VALUE',
        PrivateIpAddress: 'STRING_VALUE',
        PrivateIpAddresses: [
          {
            Primary: true || false,
            PrivateIpAddress: 'STRING_VALUE'
          },
          /* more items */
        ],
        SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
        SubnetId: 'STRING_VALUE'
      },
      /* more items */
    ],
    Placement: {
      Affinity: 'STRING_VALUE',
      AvailabilityZone: 'STRING_VALUE',
      GroupName: 'STRING_VALUE',
      HostId: 'STRING_VALUE',
      HostResourceGroupArn: 'STRING_VALUE',
      PartitionNumber: 'NUMBER_VALUE',
      SpreadDomain: 'STRING_VALUE',
      Tenancy: default | dedicated | host
    },
    RamDiskId: 'STRING_VALUE',
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    TagSpecifications: [
      {
        ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
        Tags: [
          {
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    UserData: 'STRING_VALUE'
  },
  LaunchTemplateName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  VersionDescription: 'STRING_VALUE'
};
ec2.createLaunchTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      Constraint: Maximum 128 ASCII characters.

    • LaunchTemplateName — (String)

      A name for the launch template.

    • VersionDescription — (String)

      A description for the first version of the launch template.

    • LaunchTemplateData — (map)

      The information for the launch template.

      • KernelId — (String)

        The ID of the kernel.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

      • EbsOptimized — (Boolean)

        Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

      • IamInstanceProfile — (map)

        The IAM instance profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance profile.

        • Name — (String)

          The name of the instance profile.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping.

        • DeviceName — (String)

          The device name (for example, /dev/sdh or xvdh).

        • VirtualName — (String)

          The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

        • Ebs — (map)

          Parameters used to automatically set up EBS volumes when the instance is launched.

          • Encrypted — (Boolean)

            Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

          • DeleteOnTermination — (Boolean)

            Indicates whether the EBS volume is deleted on instance termination.

          • Iops — (Integer)

            The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

            This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

          • KmsKeyId — (String)

            The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.

          • SnapshotId — (String)

            The ID of the snapshot.

          • VolumeSize — (Integer)

            The size of the volume, in GiB.

            Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

          • VolumeType — (String)

            The volume type.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "sc1"
            • "st1"
        • NoDevice — (String)

          Suppresses the specified device included in the block device mapping of the AMI.

      • NetworkInterfaces — (Array<map>)

        One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

        • AssociateCarrierIpAddress — (Boolean)

          Associates a Carrier IP address with eth0 for a new network interface.

          Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

        • AssociatePublicIpAddress — (Boolean)

          Associates a public IPv4 address with eth0 for a new network interface.

        • DeleteOnTermination — (Boolean)

          Indicates whether the network interface is deleted when the instance is terminated.

        • Description — (String)

          A description for the network interface.

        • DeviceIndex — (Integer)

          The device index for the network interface attachment.

        • Groups — (Array<String>)

          The IDs of one or more security groups.

        • InterfaceType — (String)

          The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

          If you are not creating an EFA, specify interface or omit this parameter.

          Valid values: interface | efa

        • Ipv6AddressCount — (Integer)

          The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

        • Ipv6Addresses — (Array<map>)

          One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

          • Ipv6Address — (String)

            The IPv6 address.

        • NetworkInterfaceId — (String)

          The ID of the network interface.

        • PrivateIpAddress — (String)

          The primary private IPv4 address of the network interface.

        • PrivateIpAddresses — (Array<map>)

          One or more private IPv4 addresses.

          • Primary — (Boolean)

            Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

          • PrivateIpAddress — (String)

            The private IPv4 addresses.

        • SecondaryPrivateIpAddressCount — (Integer)

          The number of secondary private IPv4 addresses to assign to a network interface.

        • SubnetId — (String)

          The ID of the subnet for the network interface.

      • ImageId — (String)

        The ID of the AMI.

      • InstanceType — (String)

        The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

        Possible values include:
        • "t1.micro"
        • "t2.nano"
        • "t2.micro"
        • "t2.small"
        • "t2.medium"
        • "t2.large"
        • "t2.xlarge"
        • "t2.2xlarge"
        • "t3.nano"
        • "t3.micro"
        • "t3.small"
        • "t3.medium"
        • "t3.large"
        • "t3.xlarge"
        • "t3.2xlarge"
        • "t3a.nano"
        • "t3a.micro"
        • "t3a.small"
        • "t3a.medium"
        • "t3a.large"
        • "t3a.xlarge"
        • "t3a.2xlarge"
        • "t4g.nano"
        • "t4g.micro"
        • "t4g.small"
        • "t4g.medium"
        • "t4g.large"
        • "t4g.xlarge"
        • "t4g.2xlarge"
        • "m1.small"
        • "m1.medium"
        • "m1.large"
        • "m1.xlarge"
        • "m3.medium"
        • "m3.large"
        • "m3.xlarge"
        • "m3.2xlarge"
        • "m4.large"
        • "m4.xlarge"
        • "m4.2xlarge"
        • "m4.4xlarge"
        • "m4.10xlarge"
        • "m4.16xlarge"
        • "m2.xlarge"
        • "m2.2xlarge"
        • "m2.4xlarge"
        • "cr1.8xlarge"
        • "r3.large"
        • "r3.xlarge"
        • "r3.2xlarge"
        • "r3.4xlarge"
        • "r3.8xlarge"
        • "r4.large"
        • "r4.xlarge"
        • "r4.2xlarge"
        • "r4.4xlarge"
        • "r4.8xlarge"
        • "r4.16xlarge"
        • "r5.large"
        • "r5.xlarge"
        • "r5.2xlarge"
        • "r5.4xlarge"
        • "r5.8xlarge"
        • "r5.12xlarge"
        • "r5.16xlarge"
        • "r5.24xlarge"
        • "r5.metal"
        • "r5a.large"
        • "r5a.xlarge"
        • "r5a.2xlarge"
        • "r5a.4xlarge"
        • "r5a.8xlarge"
        • "r5a.12xlarge"
        • "r5a.16xlarge"
        • "r5a.24xlarge"
        • "r5d.large"
        • "r5d.xlarge"
        • "r5d.2xlarge"
        • "r5d.4xlarge"
        • "r5d.8xlarge"
        • "r5d.12xlarge"
        • "r5d.16xlarge"
        • "r5d.24xlarge"
        • "r5d.metal"
        • "r5ad.large"
        • "r5ad.xlarge"
        • "r5ad.2xlarge"
        • "r5ad.4xlarge"
        • "r5ad.8xlarge"
        • "r5ad.12xlarge"
        • "r5ad.16xlarge"
        • "r5ad.24xlarge"
        • "r6g.metal"
        • "r6g.medium"
        • "r6g.large"
        • "r6g.xlarge"
        • "r6g.2xlarge"
        • "r6g.4xlarge"
        • "r6g.8xlarge"
        • "r6g.12xlarge"
        • "r6g.16xlarge"
        • "r6gd.metal"
        • "r6gd.medium"
        • "r6gd.large"
        • "r6gd.xlarge"
        • "r6gd.2xlarge"
        • "r6gd.4xlarge"
        • "r6gd.8xlarge"
        • "r6gd.12xlarge"
        • "r6gd.16xlarge"
        • "x1.16xlarge"
        • "x1.32xlarge"
        • "x1e.xlarge"
        • "x1e.2xlarge"
        • "x1e.4xlarge"
        • "x1e.8xlarge"
        • "x1e.16xlarge"
        • "x1e.32xlarge"
        • "i2.xlarge"
        • "i2.2xlarge"
        • "i2.4xlarge"
        • "i2.8xlarge"
        • "i3.large"
        • "i3.xlarge"
        • "i3.2xlarge"
        • "i3.4xlarge"
        • "i3.8xlarge"
        • "i3.16xlarge"
        • "i3.metal"
        • "i3en.large"
        • "i3en.xlarge"
        • "i3en.2xlarge"
        • "i3en.3xlarge"
        • "i3en.6xlarge"
        • "i3en.12xlarge"
        • "i3en.24xlarge"
        • "i3en.metal"
        • "hi1.4xlarge"
        • "hs1.8xlarge"
        • "c1.medium"
        • "c1.xlarge"
        • "c3.large"
        • "c3.xlarge"
        • "c3.2xlarge"
        • "c3.4xlarge"
        • "c3.8xlarge"
        • "c4.large"
        • "c4.xlarge"
        • "c4.2xlarge"
        • "c4.4xlarge"
        • "c4.8xlarge"
        • "c5.large"
        • "c5.xlarge"
        • "c5.2xlarge"
        • "c5.4xlarge"
        • "c5.9xlarge"
        • "c5.12xlarge"
        • "c5.18xlarge"
        • "c5.24xlarge"
        • "c5.metal"
        • "c5a.large"
        • "c5a.xlarge"
        • "c5a.2xlarge"
        • "c5a.4xlarge"
        • "c5a.8xlarge"
        • "c5a.12xlarge"
        • "c5a.16xlarge"
        • "c5a.24xlarge"
        • "c5ad.large"
        • "c5ad.xlarge"
        • "c5ad.2xlarge"
        • "c5ad.4xlarge"
        • "c5ad.8xlarge"
        • "c5ad.12xlarge"
        • "c5ad.16xlarge"
        • "c5ad.24xlarge"
        • "c5d.large"
        • "c5d.xlarge"
        • "c5d.2xlarge"
        • "c5d.4xlarge"
        • "c5d.9xlarge"
        • "c5d.12xlarge"
        • "c5d.18xlarge"
        • "c5d.24xlarge"
        • "c5d.metal"
        • "c5n.large"
        • "c5n.xlarge"
        • "c5n.2xlarge"
        • "c5n.4xlarge"
        • "c5n.9xlarge"
        • "c5n.18xlarge"
        • "c6g.metal"
        • "c6g.medium"
        • "c6g.large"
        • "c6g.xlarge"
        • "c6g.2xlarge"
        • "c6g.4xlarge"
        • "c6g.8xlarge"
        • "c6g.12xlarge"
        • "c6g.16xlarge"
        • "c6gd.metal"
        • "c6gd.medium"
        • "c6gd.large"
        • "c6gd.xlarge"
        • "c6gd.2xlarge"
        • "c6gd.4xlarge"
        • "c6gd.8xlarge"
        • "c6gd.12xlarge"
        • "c6gd.16xlarge"
        • "cc1.4xlarge"
        • "cc2.8xlarge"
        • "g2.2xlarge"
        • "g2.8xlarge"
        • "g3.4xlarge"
        • "g3.8xlarge"
        • "g3.16xlarge"
        • "g3s.xlarge"
        • "g4dn.xlarge"
        • "g4dn.2xlarge"
        • "g4dn.4xlarge"
        • "g4dn.8xlarge"
        • "g4dn.12xlarge"
        • "g4dn.16xlarge"
        • "g4dn.metal"
        • "cg1.4xlarge"
        • "p2.xlarge"
        • "p2.8xlarge"
        • "p2.16xlarge"
        • "p3.2xlarge"
        • "p3.8xlarge"
        • "p3.16xlarge"
        • "p3dn.24xlarge"
        • "d2.xlarge"
        • "d2.2xlarge"
        • "d2.4xlarge"
        • "d2.8xlarge"
        • "f1.2xlarge"
        • "f1.4xlarge"
        • "f1.16xlarge"
        • "m5.large"
        • "m5.xlarge"
        • "m5.2xlarge"
        • "m5.4xlarge"
        • "m5.8xlarge"
        • "m5.12xlarge"
        • "m5.16xlarge"
        • "m5.24xlarge"
        • "m5.metal"
        • "m5a.large"
        • "m5a.xlarge"
        • "m5a.2xlarge"
        • "m5a.4xlarge"
        • "m5a.8xlarge"
        • "m5a.12xlarge"
        • "m5a.16xlarge"
        • "m5a.24xlarge"
        • "m5d.large"
        • "m5d.xlarge"
        • "m5d.2xlarge"
        • "m5d.4xlarge"
        • "m5d.8xlarge"
        • "m5d.12xlarge"
        • "m5d.16xlarge"
        • "m5d.24xlarge"
        • "m5d.metal"
        • "m5ad.large"
        • "m5ad.xlarge"
        • "m5ad.2xlarge"
        • "m5ad.4xlarge"
        • "m5ad.8xlarge"
        • "m5ad.12xlarge"
        • "m5ad.16xlarge"
        • "m5ad.24xlarge"
        • "h1.2xlarge"
        • "h1.4xlarge"
        • "h1.8xlarge"
        • "h1.16xlarge"
        • "z1d.large"
        • "z1d.xlarge"
        • "z1d.2xlarge"
        • "z1d.3xlarge"
        • "z1d.6xlarge"
        • "z1d.12xlarge"
        • "z1d.metal"
        • "u-6tb1.metal"
        • "u-9tb1.metal"
        • "u-12tb1.metal"
        • "u-18tb1.metal"
        • "u-24tb1.metal"
        • "a1.medium"
        • "a1.large"
        • "a1.xlarge"
        • "a1.2xlarge"
        • "a1.4xlarge"
        • "a1.metal"
        • "m5dn.large"
        • "m5dn.xlarge"
        • "m5dn.2xlarge"
        • "m5dn.4xlarge"
        • "m5dn.8xlarge"
        • "m5dn.12xlarge"
        • "m5dn.16xlarge"
        • "m5dn.24xlarge"
        • "m5n.large"
        • "m5n.xlarge"
        • "m5n.2xlarge"
        • "m5n.4xlarge"
        • "m5n.8xlarge"
        • "m5n.12xlarge"
        • "m5n.16xlarge"
        • "m5n.24xlarge"
        • "r5dn.large"
        • "r5dn.xlarge"
        • "r5dn.2xlarge"
        • "r5dn.4xlarge"
        • "r5dn.8xlarge"
        • "r5dn.12xlarge"
        • "r5dn.16xlarge"
        • "r5dn.24xlarge"
        • "r5n.large"
        • "r5n.xlarge"
        • "r5n.2xlarge"
        • "r5n.4xlarge"
        • "r5n.8xlarge"
        • "r5n.12xlarge"
        • "r5n.16xlarge"
        • "r5n.24xlarge"
        • "inf1.xlarge"
        • "inf1.2xlarge"
        • "inf1.6xlarge"
        • "inf1.24xlarge"
        • "m6g.metal"
        • "m6g.medium"
        • "m6g.large"
        • "m6g.xlarge"
        • "m6g.2xlarge"
        • "m6g.4xlarge"
        • "m6g.8xlarge"
        • "m6g.12xlarge"
        • "m6g.16xlarge"
        • "m6gd.metal"
        • "m6gd.medium"
        • "m6gd.large"
        • "m6gd.xlarge"
        • "m6gd.2xlarge"
        • "m6gd.4xlarge"
        • "m6gd.8xlarge"
        • "m6gd.12xlarge"
        • "m6gd.16xlarge"
      • KeyName — (String)

        The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

        If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

      • Monitoring — (map)

        The monitoring for the instance.

        • Enabled — (Boolean)

          Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

      • Placement — (map)

        The placement for the instance.

        • AvailabilityZone — (String)

          The Availability Zone for the instance.

        • Affinity — (String)

          The affinity setting for an instance on a Dedicated Host.

        • GroupName — (String)

          The name of the placement group for the instance.

        • HostId — (String)

          The ID of the Dedicated Host for the instance.

        • Tenancy — (String)

          The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • SpreadDomain — (String)

          Reserved for future use.

        • HostResourceGroupArn — (String)

          The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

        • PartitionNumber — (Integer)

          The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

      • RamDiskId — (String)

        The ID of the RAM disk.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

      • DisableApiTermination — (Boolean)

        If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

      • InstanceInitiatedShutdownBehavior — (String)

        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

        Default: stop

        Possible values include:
        • "stop"
        • "terminate"
      • UserData — (String)

        The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).

      • TagSpecifications — (Array<map>)

        The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

        • ResourceType — (String)

          The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.

          Possible values include:
          • "client-vpn-endpoint"
          • "customer-gateway"
          • "dedicated-host"
          • "dhcp-options"
          • "egress-only-internet-gateway"
          • "elastic-ip"
          • "elastic-gpu"
          • "export-image-task"
          • "export-instance-task"
          • "fleet"
          • "fpga-image"
          • "host-reservation"
          • "image"
          • "import-image-task"
          • "import-snapshot-task"
          • "instance"
          • "internet-gateway"
          • "key-pair"
          • "launch-template"
          • "local-gateway-route-table-vpc-association"
          • "natgateway"
          • "network-acl"
          • "network-interface"
          • "placement-group"
          • "reserved-instances"
          • "route-table"
          • "security-group"
          • "snapshot"
          • "spot-fleet-request"
          • "spot-instances-request"
          • "subnet"
          • "traffic-mirror-filter"
          • "traffic-mirror-session"
          • "traffic-mirror-target"
          • "transit-gateway"
          • "transit-gateway-attachment"
          • "transit-gateway-multicast-domain"
          • "transit-gateway-route-table"
          • "volume"
          • "vpc"
          • "vpc-peering-connection"
          • "vpn-connection"
          • "vpn-gateway"
          • "vpc-flow-log"
        • Tags — (Array<map>)

          The tags to apply to the resource.

          • 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 255 Unicode characters.

      • ElasticGpuSpecifications — (Array<map>)

        An elastic GPU to associate with the instance.

        • Type — required — (String)

          The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.

      • ElasticInferenceAccelerators — (Array<map>)

        The elastic inference accelerator for the instance.

        • Type — required — (String)

          The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

        • Count — (Integer)

          The number of elastic inference accelerators to attach to the instance.

          Default: 1

      • SecurityGroupIds — (Array<String>)

        One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

      • SecurityGroups — (Array<String>)

        [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

      • InstanceMarketOptions — (map)

        The market (purchasing) option for the instances.

        • MarketType — (String)

          The market type.

          Possible values include:
          • "spot"
        • SpotOptions — (map)

          The options for Spot Instances.

          • MaxPrice — (String)

            The maximum hourly price you're willing to pay for the Spot Instances.

          • SpotInstanceType — (String)

            The Spot Instance request type.

            Possible values include:
            • "one-time"
            • "persistent"
          • BlockDurationMinutes — (Integer)

            The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

          • ValidUntil — (Date)

            The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

          • InstanceInterruptionBehavior — (String)

            The behavior when a Spot Instance is interrupted. The default is terminate.

            Possible values include:
            • "hibernate"
            • "stop"
            • "terminate"
      • CreditSpecification — (map)

        The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.

        • CpuCredits — required — (String)

          The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.

      • CpuOptions — (map)

        The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

        • CoreCount — (Integer)

          The number of CPU cores for the instance.

        • ThreadsPerCore — (Integer)

          The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

      • CapacityReservationSpecification — (map)

        The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

        • CapacityReservationPreference — (String)

          Indicates the instance's Capacity Reservation preferences. Possible preferences include:

          • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

          • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

          Possible values include:
          • "open"
          • "none"
        • CapacityReservationTarget — (map)

          Information about the target Capacity Reservation or Capacity Reservation group.

          • CapacityReservationId — (String)

            The ID of the Capacity Reservation in which to run the instance.

          • CapacityReservationResourceGroupArn — (String)

            The ARN of the Capacity Reservation resource group in which to run the instance.

      • LicenseSpecifications — (Array<map>)

        The license configurations.

        • LicenseConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the license configuration.

      • HibernationOptions — (map)

        Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

        • Configured — (Boolean)

          If you set this parameter to true, the instance is enabled for hibernation.

          Default: false

      • MetadataOptions — (map)

        The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

        • HttpTokens — (String)

          The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

          If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

          If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

          Possible values include:
          • "optional"
          • "required"
        • HttpPutResponseHopLimit — (Integer)

          The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

          Default: 1

          Possible values: Integers from 1 to 64

        • HttpEndpoint — (String)

          This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

          Note: If you specify a value of disabled, you will not be able to access your instance metadata.
          Possible values include:
          • "disabled"
          • "enabled"
    • TagSpecifications — (Array<map>)

      The tags to apply to the launch template during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplate — (map)

        Information about the launch template.

        • LaunchTemplateId — (String)

          The ID of the launch template.

        • LaunchTemplateName — (String)

          The name of the launch template.

        • CreateTime — (Date)

          The time launch template was created.

        • CreatedBy — (String)

          The principal that created the launch template.

        • DefaultVersionNumber — (Integer)

          The version number of the default version of the launch template.

        • LatestVersionNumber — (Integer)

          The version number of the latest version of the launch template.

        • Tags — (Array<map>)

          The tags for the launch template.

          • 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 255 Unicode characters.

      • Warning — (map)

        If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

        • Errors — (Array<map>)

          The error codes and error messages.

          • Code — (String)

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.

          • Message — (String)

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLaunchTemplateVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create a launch template version


/* This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID. */

 var params = {
  LaunchTemplateData: {
   ImageId: "ami-c998b6b2"
  }, 
  LaunchTemplateId: "lt-0abcd290751193123", 
  SourceVersion: "1", 
  VersionDescription: "WebVersion2"
 };
 ec2.createLaunchTemplateVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplateVersion: {
     CreateTime: <Date Representation>, 
     CreatedBy: "arn:aws:iam::123456789012:root", 
     DefaultVersion: false, 
     LaunchTemplateData: {
      ImageId: "ami-c998b6b2", 
      InstanceType: "t2.micro", 
      NetworkInterfaces: [
         {
        AssociatePublicIpAddress: true, 
        DeviceIndex: 0, 
        Ipv6Addresses: [
           {
          Ipv6Address: "2001:db8:1234:1a00::123"
         }
        ], 
        SubnetId: "subnet-7b16de0c"
       }
      ]
     }, 
     LaunchTemplateId: "lt-0abcd290751193123", 
     LaunchTemplateName: "my-template", 
     VersionDescription: "WebVersion2", 
     VersionNumber: 2
    }
   }
   */
 });

Calling the createLaunchTemplateVersion operation

var params = {
  LaunchTemplateData: { /* required */
    BlockDeviceMappings: [
      {
        DeviceName: 'STRING_VALUE',
        Ebs: {
          DeleteOnTermination: true || false,
          Encrypted: true || false,
          Iops: 'NUMBER_VALUE',
          KmsKeyId: 'STRING_VALUE',
          SnapshotId: 'STRING_VALUE',
          VolumeSize: 'NUMBER_VALUE',
          VolumeType: standard | io1 | io2 | gp2 | sc1 | st1
        },
        NoDevice: 'STRING_VALUE',
        VirtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    CapacityReservationSpecification: {
      CapacityReservationPreference: open | none,
      CapacityReservationTarget: {
        CapacityReservationId: 'STRING_VALUE',
        CapacityReservationResourceGroupArn: 'STRING_VALUE'
      }
    },
    CpuOptions: {
      CoreCount: 'NUMBER_VALUE',
      ThreadsPerCore: 'NUMBER_VALUE'
    },
    CreditSpecification: {
      CpuCredits: 'STRING_VALUE' /* required */
    },
    DisableApiTermination: true || false,
    EbsOptimized: true || false,
    ElasticGpuSpecifications: [
      {
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ElasticInferenceAccelerators: [
      {
        Type: 'STRING_VALUE', /* required */
        Count: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    HibernationOptions: {
      Configured: true || false
    },
    IamInstanceProfile: {
      Arn: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    },
    ImageId: 'STRING_VALUE',
    InstanceInitiatedShutdownBehavior: stop | terminate,
    InstanceMarketOptions: {
      MarketType: spot,
      SpotOptions: {
        BlockDurationMinutes: 'NUMBER_VALUE',
        InstanceInterruptionBehavior: hibernate | stop | terminate,
        MaxPrice: 'STRING_VALUE',
        SpotInstanceType: one-time | persistent,
        ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      }
    },
    InstanceType: t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r6g.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6gd.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | hi1.4xlarge | hs1.8xlarge | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c6g.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6gd.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | cc1.4xlarge | cc2.8xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | cg1.4xlarge | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge,
    KernelId: 'STRING_VALUE',
    KeyName: 'STRING_VALUE',
    LicenseSpecifications: [
      {
        LicenseConfigurationArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    MetadataOptions: {
      HttpEndpoint: disabled | enabled,
      HttpPutResponseHopLimit: 'NUMBER_VALUE',
      HttpTokens: optional | required
    },
    Monitoring: {
      Enabled: true || false
    },
    NetworkInterfaces: [
      {
        AssociateCarrierIpAddress: true || false,
        AssociatePublicIpAddress: true || false,
        DeleteOnTermination: true || false,
        Description: 'STRING_VALUE',
        DeviceIndex: 'NUMBER_VALUE',
        Groups: [
          'STRING_VALUE',
          /* more items */
        ],
        InterfaceType: 'STRING_VALUE',
        Ipv6AddressCount: 'NUMBER_VALUE',
        Ipv6Addresses: [
          {
            Ipv6Address: 'STRING_VALUE'
          },
          /* more items */
        ],
        NetworkInterfaceId: 'STRING_VALUE',
        PrivateIpAddress: 'STRING_VALUE',
        PrivateIpAddresses: [
          {
            Primary: true || false,
            PrivateIpAddress: 'STRING_VALUE'
          },
          /* more items */
        ],
        SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
        SubnetId: 'STRING_VALUE'
      },
      /* more items */
    ],
    Placement: {
      Affinity: 'STRING_VALUE',
      AvailabilityZone: 'STRING_VALUE',
      GroupName: 'STRING_VALUE',
      HostId: 'STRING_VALUE',
      HostResourceGroupArn: 'STRING_VALUE',
      PartitionNumber: 'NUMBER_VALUE',
      SpreadDomain: 'STRING_VALUE',
      Tenancy: default | dedicated | host
    },
    RamDiskId: 'STRING_VALUE',
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    TagSpecifications: [
      {
        ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
        Tags: [
          {
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    UserData: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  LaunchTemplateId: 'STRING_VALUE',
  LaunchTemplateName: 'STRING_VALUE',
  SourceVersion: 'STRING_VALUE',
  VersionDescription: 'STRING_VALUE'
};
ec2.createLaunchTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      Constraint: Maximum 128 ASCII characters.

    • LaunchTemplateId — (String)

      The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

    • LaunchTemplateName — (String)

      The name of the launch template. You must specify either the launch template ID or launch template name in the request.

    • SourceVersion — (String)

      The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.

    • VersionDescription — (String)

      A description for the version of the launch template.

    • LaunchTemplateData — (map)

      The information for the launch template.

      • KernelId — (String)

        The ID of the kernel.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

      • EbsOptimized — (Boolean)

        Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

      • IamInstanceProfile — (map)

        The IAM instance profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance profile.

        • Name — (String)

          The name of the instance profile.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping.

        • DeviceName — (String)

          The device name (for example, /dev/sdh or xvdh).

        • VirtualName — (String)

          The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

        • Ebs — (map)

          Parameters used to automatically set up EBS volumes when the instance is launched.

          • Encrypted — (Boolean)

            Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

          • DeleteOnTermination — (Boolean)

            Indicates whether the EBS volume is deleted on instance termination.

          • Iops — (Integer)

            The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

            This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

          • KmsKeyId — (String)

            The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.

          • SnapshotId — (String)

            The ID of the snapshot.

          • VolumeSize — (Integer)

            The size of the volume, in GiB.

            Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

          • VolumeType — (String)

            The volume type.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "sc1"
            • "st1"
        • NoDevice — (String)

          Suppresses the specified device included in the block device mapping of the AMI.

      • NetworkInterfaces — (Array<map>)

        One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

        • AssociateCarrierIpAddress — (Boolean)

          Associates a Carrier IP address with eth0 for a new network interface.

          Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

        • AssociatePublicIpAddress — (Boolean)

          Associates a public IPv4 address with eth0 for a new network interface.

        • DeleteOnTermination — (Boolean)

          Indicates whether the network interface is deleted when the instance is terminated.

        • Description — (String)

          A description for the network interface.

        • DeviceIndex — (Integer)

          The device index for the network interface attachment.

        • Groups — (Array<String>)

          The IDs of one or more security groups.

        • InterfaceType — (String)

          The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

          If you are not creating an EFA, specify interface or omit this parameter.

          Valid values: interface | efa

        • Ipv6AddressCount — (Integer)

          The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

        • Ipv6Addresses — (Array<map>)

          One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

          • Ipv6Address — (String)

            The IPv6 address.

        • NetworkInterfaceId — (String)

          The ID of the network interface.

        • PrivateIpAddress — (String)

          The primary private IPv4 address of the network interface.

        • PrivateIpAddresses — (Array<map>)

          One or more private IPv4 addresses.

          • Primary — (Boolean)

            Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

          • PrivateIpAddress — (String)

            The private IPv4 addresses.

        • SecondaryPrivateIpAddressCount — (Integer)

          The number of secondary private IPv4 addresses to assign to a network interface.

        • SubnetId — (String)

          The ID of the subnet for the network interface.

      • ImageId — (String)

        The ID of the AMI.

      • InstanceType — (String)

        The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

        Possible values include:
        • "t1.micro"
        • "t2.nano"
        • "t2.micro"
        • "t2.small"
        • "t2.medium"
        • "t2.large"
        • "t2.xlarge"
        • "t2.2xlarge"
        • "t3.nano"
        • "t3.micro"
        • "t3.small"
        • "t3.medium"
        • "t3.large"
        • "t3.xlarge"
        • "t3.2xlarge"
        • "t3a.nano"
        • "t3a.micro"
        • "t3a.small"
        • "t3a.medium"
        • "t3a.large"
        • "t3a.xlarge"
        • "t3a.2xlarge"
        • "t4g.nano"
        • "t4g.micro"
        • "t4g.small"
        • "t4g.medium"
        • "t4g.large"
        • "t4g.xlarge"
        • "t4g.2xlarge"
        • "m1.small"
        • "m1.medium"
        • "m1.large"
        • "m1.xlarge"
        • "m3.medium"
        • "m3.large"
        • "m3.xlarge"
        • "m3.2xlarge"
        • "m4.large"
        • "m4.xlarge"
        • "m4.2xlarge"
        • "m4.4xlarge"
        • "m4.10xlarge"
        • "m4.16xlarge"
        • "m2.xlarge"
        • "m2.2xlarge"
        • "m2.4xlarge"
        • "cr1.8xlarge"
        • "r3.large"
        • "r3.xlarge"
        • "r3.2xlarge"
        • "r3.4xlarge"
        • "r3.8xlarge"
        • "r4.large"
        • "r4.xlarge"
        • "r4.2xlarge"
        • "r4.4xlarge"
        • "r4.8xlarge"
        • "r4.16xlarge"
        • "r5.large"
        • "r5.xlarge"
        • "r5.2xlarge"
        • "r5.4xlarge"
        • "r5.8xlarge"
        • "r5.12xlarge"
        • "r5.16xlarge"
        • "r5.24xlarge"
        • "r5.metal"
        • "r5a.large"
        • "r5a.xlarge"
        • "r5a.2xlarge"
        • "r5a.4xlarge"
        • "r5a.8xlarge"
        • "r5a.12xlarge"
        • "r5a.16xlarge"
        • "r5a.24xlarge"
        • "r5d.large"
        • "r5d.xlarge"
        • "r5d.2xlarge"
        • "r5d.4xlarge"
        • "r5d.8xlarge"
        • "r5d.12xlarge"
        • "r5d.16xlarge"
        • "r5d.24xlarge"
        • "r5d.metal"
        • "r5ad.large"
        • "r5ad.xlarge"
        • "r5ad.2xlarge"
        • "r5ad.4xlarge"
        • "r5ad.8xlarge"
        • "r5ad.12xlarge"
        • "r5ad.16xlarge"
        • "r5ad.24xlarge"
        • "r6g.metal"
        • "r6g.medium"
        • "r6g.large"
        • "r6g.xlarge"
        • "r6g.2xlarge"
        • "r6g.4xlarge"
        • "r6g.8xlarge"
        • "r6g.12xlarge"
        • "r6g.16xlarge"
        • "r6gd.metal"
        • "r6gd.medium"
        • "r6gd.large"
        • "r6gd.xlarge"
        • "r6gd.2xlarge"
        • "r6gd.4xlarge"
        • "r6gd.8xlarge"
        • "r6gd.12xlarge"
        • "r6gd.16xlarge"
        • "x1.16xlarge"
        • "x1.32xlarge"
        • "x1e.xlarge"
        • "x1e.2xlarge"
        • "x1e.4xlarge"
        • "x1e.8xlarge"
        • "x1e.16xlarge"
        • "x1e.32xlarge"
        • "i2.xlarge"
        • "i2.2xlarge"
        • "i2.4xlarge"
        • "i2.8xlarge"
        • "i3.large"
        • "i3.xlarge"
        • "i3.2xlarge"
        • "i3.4xlarge"
        • "i3.8xlarge"
        • "i3.16xlarge"
        • "i3.metal"
        • "i3en.large"
        • "i3en.xlarge"
        • "i3en.2xlarge"
        • "i3en.3xlarge"
        • "i3en.6xlarge"
        • "i3en.12xlarge"
        • "i3en.24xlarge"
        • "i3en.metal"
        • "hi1.4xlarge"
        • "hs1.8xlarge"
        • "c1.medium"
        • "c1.xlarge"
        • "c3.large"
        • "c3.xlarge"
        • "c3.2xlarge"
        • "c3.4xlarge"
        • "c3.8xlarge"
        • "c4.large"
        • "c4.xlarge"
        • "c4.2xlarge"
        • "c4.4xlarge"
        • "c4.8xlarge"
        • "c5.large"
        • "c5.xlarge"
        • "c5.2xlarge"
        • "c5.4xlarge"
        • "c5.9xlarge"
        • "c5.12xlarge"
        • "c5.18xlarge"
        • "c5.24xlarge"
        • "c5.metal"
        • "c5a.large"
        • "c5a.xlarge"
        • "c5a.2xlarge"
        • "c5a.4xlarge"
        • "c5a.8xlarge"
        • "c5a.12xlarge"
        • "c5a.16xlarge"
        • "c5a.24xlarge"
        • "c5ad.large"
        • "c5ad.xlarge"
        • "c5ad.2xlarge"
        • "c5ad.4xlarge"
        • "c5ad.8xlarge"
        • "c5ad.12xlarge"
        • "c5ad.16xlarge"
        • "c5ad.24xlarge"
        • "c5d.large"
        • "c5d.xlarge"
        • "c5d.2xlarge"
        • "c5d.4xlarge"
        • "c5d.9xlarge"
        • "c5d.12xlarge"
        • "c5d.18xlarge"
        • "c5d.24xlarge"
        • "c5d.metal"
        • "c5n.large"
        • "c5n.xlarge"
        • "c5n.2xlarge"
        • "c5n.4xlarge"
        • "c5n.9xlarge"
        • "c5n.18xlarge"
        • "c6g.metal"
        • "c6g.medium"
        • "c6g.large"
        • "c6g.xlarge"
        • "c6g.2xlarge"
        • "c6g.4xlarge"
        • "c6g.8xlarge"
        • "c6g.12xlarge"
        • "c6g.16xlarge"
        • "c6gd.metal"
        • "c6gd.medium"
        • "c6gd.large"
        • "c6gd.xlarge"
        • "c6gd.2xlarge"
        • "c6gd.4xlarge"
        • "c6gd.8xlarge"
        • "c6gd.12xlarge"
        • "c6gd.16xlarge"
        • "cc1.4xlarge"
        • "cc2.8xlarge"
        • "g2.2xlarge"
        • "g2.8xlarge"
        • "g3.4xlarge"
        • "g3.8xlarge"
        • "g3.16xlarge"
        • "g3s.xlarge"
        • "g4dn.xlarge"
        • "g4dn.2xlarge"
        • "g4dn.4xlarge"
        • "g4dn.8xlarge"
        • "g4dn.12xlarge"
        • "g4dn.16xlarge"
        • "g4dn.metal"
        • "cg1.4xlarge"
        • "p2.xlarge"
        • "p2.8xlarge"
        • "p2.16xlarge"
        • "p3.2xlarge"
        • "p3.8xlarge"
        • "p3.16xlarge"
        • "p3dn.24xlarge"
        • "d2.xlarge"
        • "d2.2xlarge"
        • "d2.4xlarge"
        • "d2.8xlarge"
        • "f1.2xlarge"
        • "f1.4xlarge"
        • "f1.16xlarge"
        • "m5.large"
        • "m5.xlarge"
        • "m5.2xlarge"
        • "m5.4xlarge"
        • "m5.8xlarge"
        • "m5.12xlarge"
        • "m5.16xlarge"
        • "m5.24xlarge"
        • "m5.metal"
        • "m5a.large"
        • "m5a.xlarge"
        • "m5a.2xlarge"
        • "m5a.4xlarge"
        • "m5a.8xlarge"
        • "m5a.12xlarge"
        • "m5a.16xlarge"
        • "m5a.24xlarge"
        • "m5d.large"
        • "m5d.xlarge"
        • "m5d.2xlarge"
        • "m5d.4xlarge"
        • "m5d.8xlarge"
        • "m5d.12xlarge"
        • "m5d.16xlarge"
        • "m5d.24xlarge"
        • "m5d.metal"
        • "m5ad.large"
        • "m5ad.xlarge"
        • "m5ad.2xlarge"
        • "m5ad.4xlarge"
        • "m5ad.8xlarge"
        • "m5ad.12xlarge"
        • "m5ad.16xlarge"
        • "m5ad.24xlarge"
        • "h1.2xlarge"
        • "h1.4xlarge"
        • "h1.8xlarge"
        • "h1.16xlarge"
        • "z1d.large"
        • "z1d.xlarge"
        • "z1d.2xlarge"
        • "z1d.3xlarge"
        • "z1d.6xlarge"
        • "z1d.12xlarge"
        • "z1d.metal"
        • "u-6tb1.metal"
        • "u-9tb1.metal"
        • "u-12tb1.metal"
        • "u-18tb1.metal"
        • "u-24tb1.metal"
        • "a1.medium"
        • "a1.large"
        • "a1.xlarge"
        • "a1.2xlarge"
        • "a1.4xlarge"
        • "a1.metal"
        • "m5dn.large"
        • "m5dn.xlarge"
        • "m5dn.2xlarge"
        • "m5dn.4xlarge"
        • "m5dn.8xlarge"
        • "m5dn.12xlarge"
        • "m5dn.16xlarge"
        • "m5dn.24xlarge"
        • "m5n.large"
        • "m5n.xlarge"
        • "m5n.2xlarge"
        • "m5n.4xlarge"
        • "m5n.8xlarge"
        • "m5n.12xlarge"
        • "m5n.16xlarge"
        • "m5n.24xlarge"
        • "r5dn.large"
        • "r5dn.xlarge"
        • "r5dn.2xlarge"
        • "r5dn.4xlarge"
        • "r5dn.8xlarge"
        • "r5dn.12xlarge"
        • "r5dn.16xlarge"
        • "r5dn.24xlarge"
        • "r5n.large"
        • "r5n.xlarge"
        • "r5n.2xlarge"
        • "r5n.4xlarge"
        • "r5n.8xlarge"
        • "r5n.12xlarge"
        • "r5n.16xlarge"
        • "r5n.24xlarge"
        • "inf1.xlarge"
        • "inf1.2xlarge"
        • "inf1.6xlarge"
        • "inf1.24xlarge"
        • "m6g.metal"
        • "m6g.medium"
        • "m6g.large"
        • "m6g.xlarge"
        • "m6g.2xlarge"
        • "m6g.4xlarge"
        • "m6g.8xlarge"
        • "m6g.12xlarge"
        • "m6g.16xlarge"
        • "m6gd.metal"
        • "m6gd.medium"
        • "m6gd.large"
        • "m6gd.xlarge"
        • "m6gd.2xlarge"
        • "m6gd.4xlarge"
        • "m6gd.8xlarge"
        • "m6gd.12xlarge"
        • "m6gd.16xlarge"
      • KeyName — (String)

        The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

        If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

      • Monitoring — (map)

        The monitoring for the instance.

        • Enabled — (Boolean)

          Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

      • Placement — (map)

        The placement for the instance.

        • AvailabilityZone — (String)

          The Availability Zone for the instance.

        • Affinity — (String)

          The affinity setting for an instance on a Dedicated Host.

        • GroupName — (String)

          The name of the placement group for the instance.

        • HostId — (String)

          The ID of the Dedicated Host for the instance.

        • Tenancy — (String)

          The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • SpreadDomain — (String)

          Reserved for future use.

        • HostResourceGroupArn — (String)

          The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

        • PartitionNumber — (Integer)

          The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

      • RamDiskId — (String)

        The ID of the RAM disk.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

      • DisableApiTermination — (Boolean)

        If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

      • InstanceInitiatedShutdownBehavior — (String)

        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

        Default: stop

        Possible values include:
        • "stop"
        • "terminate"
      • UserData — (String)

        The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).

      • TagSpecifications — (Array<map>)

        The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

        • ResourceType — (String)

          The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.

          Possible values include:
          • "client-vpn-endpoint"
          • "customer-gateway"
          • "dedicated-host"
          • "dhcp-options"
          • "egress-only-internet-gateway"
          • "elastic-ip"
          • "elastic-gpu"
          • "export-image-task"
          • "export-instance-task"
          • "fleet"
          • "fpga-image"
          • "host-reservation"
          • "image"
          • "import-image-task"
          • "import-snapshot-task"
          • "instance"
          • "internet-gateway"
          • "key-pair"
          • "launch-template"
          • "local-gateway-route-table-vpc-association"
          • "natgateway"
          • "network-acl"
          • "network-interface"
          • "placement-group"
          • "reserved-instances"
          • "route-table"
          • "security-group"
          • "snapshot"
          • "spot-fleet-request"
          • "spot-instances-request"
          • "subnet"
          • "traffic-mirror-filter"
          • "traffic-mirror-session"
          • "traffic-mirror-target"
          • "transit-gateway"
          • "transit-gateway-attachment"
          • "transit-gateway-multicast-domain"
          • "transit-gateway-route-table"
          • "volume"
          • "vpc"
          • "vpc-peering-connection"
          • "vpn-connection"
          • "vpn-gateway"
          • "vpc-flow-log"
        • Tags — (Array<map>)

          The tags to apply to the resource.

          • 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 255 Unicode characters.

      • ElasticGpuSpecifications — (Array<map>)

        An elastic GPU to associate with the instance.

        • Type — required — (String)

          The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.

      • ElasticInferenceAccelerators — (Array<map>)

        The elastic inference accelerator for the instance.

        • Type — required — (String)

          The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

        • Count — (Integer)

          The number of elastic inference accelerators to attach to the instance.

          Default: 1

      • SecurityGroupIds — (Array<String>)

        One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

      • SecurityGroups — (Array<String>)

        [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

      • InstanceMarketOptions — (map)

        The market (purchasing) option for the instances.

        • MarketType — (String)

          The market type.

          Possible values include:
          • "spot"
        • SpotOptions — (map)

          The options for Spot Instances.

          • MaxPrice — (String)

            The maximum hourly price you're willing to pay for the Spot Instances.

          • SpotInstanceType — (String)

            The Spot Instance request type.

            Possible values include:
            • "one-time"
            • "persistent"
          • BlockDurationMinutes — (Integer)

            The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

          • ValidUntil — (Date)

            The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

          • InstanceInterruptionBehavior — (String)

            The behavior when a Spot Instance is interrupted. The default is terminate.

            Possible values include:
            • "hibernate"
            • "stop"
            • "terminate"
      • CreditSpecification — (map)

        The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.

        • CpuCredits — required — (String)

          The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.

      • CpuOptions — (map)

        The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

        • CoreCount — (Integer)

          The number of CPU cores for the instance.

        • ThreadsPerCore — (Integer)

          The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

      • CapacityReservationSpecification — (map)

        The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

        • CapacityReservationPreference — (String)

          Indicates the instance's Capacity Reservation preferences. Possible preferences include:

          • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

          • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

          Possible values include:
          • "open"
          • "none"
        • CapacityReservationTarget — (map)

          Information about the target Capacity Reservation or Capacity Reservation group.

          • CapacityReservationId — (String)

            The ID of the Capacity Reservation in which to run the instance.

          • CapacityReservationResourceGroupArn — (String)

            The ARN of the Capacity Reservation resource group in which to run the instance.

      • LicenseSpecifications — (Array<map>)

        The license configurations.

        • LicenseConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the license configuration.

      • HibernationOptions — (map)

        Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

        • Configured — (Boolean)

          If you set this parameter to true, the instance is enabled for hibernation.

          Default: false

      • MetadataOptions — (map)

        The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

        • HttpTokens — (String)

          The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

          If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

          If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

          Possible values include:
          • "optional"
          • "required"
        • HttpPutResponseHopLimit — (Integer)

          The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

          Default: 1

          Possible values: Integers from 1 to 64

        • HttpEndpoint — (String)

          This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

          Note: If you specify a value of disabled, you will not be able to access your instance metadata.
          Possible values include:
          • "disabled"
          • "enabled"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplateVersion — (map)

        Information about the launch template version.

        • LaunchTemplateId — (String)

          The ID of the launch template.

        • LaunchTemplateName — (String)

          The name of the launch template.

        • VersionNumber — (Integer)

          The version number.

        • VersionDescription — (String)

          The description for the version.

        • CreateTime — (Date)

          The time the version was created.

        • CreatedBy — (String)

          The principal that created the version.

        • DefaultVersion — (Boolean)

          Indicates whether the version is the default version.

        • LaunchTemplateData — (map)

          Information about the launch template.

          • KernelId — (String)

            The ID of the kernel, if applicable.

          • EbsOptimized — (Boolean)

            Indicates whether the instance is optimized for Amazon EBS I/O.

          • IamInstanceProfile — (map)

            The IAM instance profile.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the instance profile.

            • Name — (String)

              The name of the instance profile.

          • BlockDeviceMappings — (Array<map>)

            The block device mappings.

            • DeviceName — (String)

              The device name.

            • VirtualName — (String)

              The virtual device name (ephemeralN).

            • Ebs — (map)

              Information about the block device for an EBS volume.

              • Encrypted — (Boolean)

                Indicates whether the EBS volume is encrypted.

              • DeleteOnTermination — (Boolean)

                Indicates whether the EBS volume is deleted on instance termination.

              • Iops — (Integer)

                The number of I/O operations per second (IOPS) that the volume supports.

              • KmsKeyId — (String)

                The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

              • SnapshotId — (String)

                The ID of the snapshot.

              • VolumeSize — (Integer)

                The size of the volume, in GiB.

              • VolumeType — (String)

                The volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "sc1"
                • "st1"
            • NoDevice — (String)

              Suppresses the specified device included in the block device mapping of the AMI.

          • NetworkInterfaces — (Array<map>)

            The network interfaces.

            • AssociateCarrierIpAddress — (Boolean)

              Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

              Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

            • AssociatePublicIpAddress — (Boolean)

              Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

            • DeleteOnTermination — (Boolean)

              Indicates whether the network interface is deleted when the instance is terminated.

            • Description — (String)

              A description for the network interface.

            • DeviceIndex — (Integer)

              The device index for the network interface attachment.

            • Groups — (Array<String>)

              The IDs of one or more security groups.

            • InterfaceType — (String)

              The type of network interface.

            • Ipv6AddressCount — (Integer)

              The number of IPv6 addresses for the network interface.

            • Ipv6Addresses — (Array<map>)

              The IPv6 addresses for the network interface.

              • Ipv6Address — (String)

                The IPv6 address.

            • NetworkInterfaceId — (String)

              The ID of the network interface.

            • PrivateIpAddress — (String)

              The primary private IPv4 address of the network interface.

            • PrivateIpAddresses — (Array<map>)

              One or more private IPv4 addresses.

              • Primary — (Boolean)

                Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

              • PrivateIpAddress — (String)

                The private IPv4 addresses.

            • SecondaryPrivateIpAddressCount — (Integer)

              The number of secondary private IPv4 addresses for the network interface.

            • SubnetId — (String)

              The ID of the subnet for the network interface.

          • ImageId — (String)

            The ID of the AMI that was used to launch the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "t1.micro"
            • "t2.nano"
            • "t2.micro"
            • "t2.small"
            • "t2.medium"
            • "t2.large"
            • "t2.xlarge"
            • "t2.2xlarge"
            • "t3.nano"
            • "t3.micro"
            • "t3.small"
            • "t3.medium"
            • "t3.large"
            • "t3.xlarge"
            • "t3.2xlarge"
            • "t3a.nano"
            • "t3a.micro"
            • "t3a.small"
            • "t3a.medium"
            • "t3a.large"
            • "t3a.xlarge"
            • "t3a.2xlarge"
            • "t4g.nano"
            • "t4g.micro"
            • "t4g.small"
            • "t4g.medium"
            • "t4g.large"
            • "t4g.xlarge"
            • "t4g.2xlarge"
            • "m1.small"
            • "m1.medium"
            • "m1.large"
            • "m1.xlarge"
            • "m3.medium"
            • "m3.large"
            • "m3.xlarge"
            • "m3.2xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m4.16xlarge"
            • "m2.xlarge"
            • "m2.2xlarge"
            • "m2.4xlarge"
            • "cr1.8xlarge"
            • "r3.large"
            • "r3.xlarge"
            • "r3.2xlarge"
            • "r3.4xlarge"
            • "r3.8xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5.metal"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "r5d.large"
            • "r5d.xlarge"
            • "r5d.2xlarge"
            • "r5d.4xlarge"
            • "r5d.8xlarge"
            • "r5d.12xlarge"
            • "r5d.16xlarge"
            • "r5d.24xlarge"
            • "r5d.metal"
            • "r5ad.large"
            • "r5ad.xlarge"
            • "r5ad.2xlarge"
            • "r5ad.4xlarge"
            • "r5ad.8xlarge"
            • "r5ad.12xlarge"
            • "r5ad.16xlarge"
            • "r5ad.24xlarge"
            • "r6g.metal"
            • "r6g.medium"
            • "r6g.large"
            • "r6g.xlarge"
            • "r6g.2xlarge"
            • "r6g.4xlarge"
            • "r6g.8xlarge"
            • "r6g.12xlarge"
            • "r6g.16xlarge"
            • "r6gd.metal"
            • "r6gd.medium"
            • "r6gd.large"
            • "r6gd.xlarge"
            • "r6gd.2xlarge"
            • "r6gd.4xlarge"
            • "r6gd.8xlarge"
            • "r6gd.12xlarge"
            • "r6gd.16xlarge"
            • "x1.16xlarge"
            • "x1.32xlarge"
            • "x1e.xlarge"
            • "x1e.2xlarge"
            • "x1e.4xlarge"
            • "x1e.8xlarge"
            • "x1e.16xlarge"
            • "x1e.32xlarge"
            • "i2.xlarge"
            • "i2.2xlarge"
            • "i2.4xlarge"
            • "i2.8xlarge"
            • "i3.large"
            • "i3.xlarge"
            • "i3.2xlarge"
            • "i3.4xlarge"
            • "i3.8xlarge"
            • "i3.16xlarge"
            • "i3.metal"
            • "i3en.large"
            • "i3en.xlarge"
            • "i3en.2xlarge"
            • "i3en.3xlarge"
            • "i3en.6xlarge"
            • "i3en.12xlarge"
            • "i3en.24xlarge"
            • "i3en.metal"
            • "hi1.4xlarge"
            • "hs1.8xlarge"
            • "c1.medium"
            • "c1.xlarge"
            • "c3.large"
            • "c3.xlarge"
            • "c3.2xlarge"
            • "c3.4xlarge"
            • "c3.8xlarge"
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5.metal"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "c5ad.large"
            • "c5ad.xlarge"
            • "c5ad.2xlarge"
            • "c5ad.4xlarge"
            • "c5ad.8xlarge"
            • "c5ad.12xlarge"
            • "c5ad.16xlarge"
            • "c5ad.24xlarge"
            • "c5d.large"
            • "c5d.xlarge"
            • "c5d.2xlarge"
            • "c5d.4xlarge"
            • "c5d.9xlarge"
            • "c5d.12xlarge"
            • "c5d.18xlarge"
            • "c5d.24xlarge"
            • "c5d.metal"
            • "c5n.large"
            • "c5n.xlarge"
            • "c5n.2xlarge"
            • "c5n.4xlarge"
            • "c5n.9xlarge"
            • "c5n.18xlarge"
            • "c6g.metal"
            • "c6g.medium"
            • "c6g.large"
            • "c6g.xlarge"
            • "c6g.2xlarge"
            • "c6g.4xlarge"
            • "c6g.8xlarge"
            • "c6g.12xlarge"
            • "c6g.16xlarge"
            • "c6gd.metal"
            • "c6gd.medium"
            • "c6gd.large"
            • "c6gd.xlarge"
            • "c6gd.2xlarge"
            • "c6gd.4xlarge"
            • "c6gd.8xlarge"
            • "c6gd.12xlarge"
            • "c6gd.16xlarge"
            • "cc1.4xlarge"
            • "cc2.8xlarge"
            • "g2.2xlarge"
            • "g2.8xlarge"
            • "g3.4xlarge"
            • "g3.8xlarge"
            • "g3.16xlarge"
            • "g3s.xlarge"
            • "g4dn.xlarge"
            • "g4dn.2xlarge"
            • "g4dn.4xlarge"
            • "g4dn.8xlarge"
            • "g4dn.12xlarge"
            • "g4dn.16xlarge"
            • "g4dn.metal"
            • "cg1.4xlarge"
            • "p2.xlarge"
            • "p2.8xlarge"
            • "p2.16xlarge"
            • "p3.2xlarge"
            • "p3.8xlarge"
            • "p3.16xlarge"
            • "p3dn.24xlarge"
            • "d2.xlarge"
            • "d2.2xlarge"
            • "d2.4xlarge"
            • "d2.8xlarge"
            • "f1.2xlarge"
            • "f1.4xlarge"
            • "f1.16xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5.metal"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
            • "m5d.large"
            • "m5d.xlarge"
            • "m5d.2xlarge"
            • "m5d.4xlarge"
            • "m5d.8xlarge"
            • "m5d.12xlarge"
            • "m5d.16xlarge"
            • "m5d.24xlarge"
            • "m5d.metal"
            • "m5ad.large"
            • "m5ad.xlarge"
            • "m5ad.2xlarge"
            • "m5ad.4xlarge"
            • "m5ad.8xlarge"
            • "m5ad.12xlarge"
            • "m5ad.16xlarge"
            • "m5ad.24xlarge"
            • "h1.2xlarge"
            • "h1.4xlarge"
            • "h1.8xlarge"
            • "h1.16xlarge"
            • "z1d.large"
            • "z1d.xlarge"
            • "z1d.2xlarge"
            • "z1d.3xlarge"
            • "z1d.6xlarge"
            • "z1d.12xlarge"
            • "z1d.metal"
            • "u-6tb1.metal"
            • "u-9tb1.metal"
            • "u-12tb1.metal"
            • "u-18tb1.metal"
            • "u-24tb1.metal"
            • "a1.medium"
            • "a1.large"
            • "a1.xlarge"
            • "a1.2xlarge"
            • "a1.4xlarge"
            • "a1.metal"
            • "m5dn.large"
            • "m5dn.xlarge"
            • "m5dn.2xlarge"
            • "m5dn.4xlarge"
            • "m5dn.8xlarge"
            • "m5dn.12xlarge"
            • "m5dn.16xlarge"
            • "m5dn.24xlarge"
            • "m5n.large"
            • "m5n.xlarge"
            • "m5n.2xlarge"
            • "m5n.4xlarge"
            • "m5n.8xlarge"
            • "m5n.12xlarge"
            • "m5n.16xlarge"
            • "m5n.24xlarge"
            • "r5dn.large"
            • "r5dn.xlarge"
            • "r5dn.2xlarge"
            • "r5dn.4xlarge"
            • "r5dn.8xlarge"
            • "r5dn.12xlarge"
            • "r5dn.16xlarge"
            • "r5dn.24xlarge"
            • "r5n.large"
            • "r5n.xlarge"
            • "r5n.2xlarge"
            • "r5n.4xlarge"
            • "r5n.8xlarge"
            • "r5n.12xlarge"
            • "r5n.16xlarge"
            • "r5n.24xlarge"
            • "inf1.xlarge"
            • "inf1.2xlarge"
            • "inf1.6xlarge"
            • "inf1.24xlarge"
            • "m6g.metal"
            • "m6g.medium"
            • "m6g.large"
            • "m6g.xlarge"
            • "m6g.2xlarge"
            • "m6g.4xlarge"
            • "m6g.8xlarge"
            • "m6g.12xlarge"
            • "m6g.16xlarge"
            • "m6gd.metal"
            • "m6gd.medium"
            • "m6gd.large"
            • "m6gd.xlarge"
            • "m6gd.2xlarge"
            • "m6gd.4xlarge"
            • "m6gd.8xlarge"
            • "m6gd.12xlarge"
            • "m6gd.16xlarge"
          • KeyName — (String)

            The name of the key pair.

          • Monitoring — (map)

            The monitoring for the instance.

            • Enabled — (Boolean)

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

          • Placement — (map)

            The placement of the instance.

            • AvailabilityZone — (String)

              The Availability Zone of the instance.

            • Affinity — (String)

              The affinity setting for the instance on the Dedicated Host.

            • GroupName — (String)

              The name of the placement group for the instance.

            • HostId — (String)

              The ID of the Dedicated Host for the instance.

            • Tenancy — (String)

              The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

              Possible values include:
              • "default"
              • "dedicated"
              • "host"
            • SpreadDomain — (String)

              Reserved for future use.

            • HostResourceGroupArn — (String)

              The ARN of the host resource group in which to launch the instances.

            • PartitionNumber — (Integer)

              The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

          • RamDiskId — (String)

            The ID of the RAM disk, if applicable.

          • DisableApiTermination — (Boolean)

            If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

          • InstanceInitiatedShutdownBehavior — (String)

            Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

            Possible values include:
            • "stop"
            • "terminate"
          • UserData — (String)

            The user data for the instance.

          • TagSpecifications — (Array<map>)

            The tags.

            • ResourceType — (String)

              The type of resource.

              Possible values include:
              • "client-vpn-endpoint"
              • "customer-gateway"
              • "dedicated-host"
              • "dhcp-options"
              • "egress-only-internet-gateway"
              • "elastic-ip"
              • "elastic-gpu"
              • "export-image-task"
              • "export-instance-task"
              • "fleet"
              • "fpga-image"
              • "host-reservation"
              • "image"
              • "import-image-task"
              • "import-snapshot-task"
              • "instance"
              • "internet-gateway"
              • "key-pair"
              • "launch-template"
              • "local-gateway-route-table-vpc-association"
              • "natgateway"
              • "network-acl"
              • "network-interface"
              • "placement-group"
              • "reserved-instances"
              • "route-table"
              • "security-group"
              • "snapshot"
              • "spot-fleet-request"
              • "spot-instances-request"
              • "subnet"
              • "traffic-mirror-filter"
              • "traffic-mirror-session"
              • "traffic-mirror-target"
              • "transit-gateway"
              • "transit-gateway-attachment"
              • "transit-gateway-multicast-domain"
              • "transit-gateway-route-table"
              • "volume"
              • "vpc"
              • "vpc-peering-connection"
              • "vpn-connection"
              • "vpn-gateway"
              • "vpc-flow-log"
            • Tags — (Array<map>)

              The tags for the resource.

              • 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 255 Unicode characters.

          • ElasticGpuSpecifications — (Array<map>)

            The elastic GPU specification.

            • Type — (String)

              The elastic GPU type.

          • ElasticInferenceAccelerators — (Array<map>)

            The elastic inference accelerator for the instance.

            • Type — (String)

              The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

            • Count — (Integer)

              The number of elastic inference accelerators to attach to the instance.

              Default: 1

          • SecurityGroupIds — (Array<String>)

            The security group IDs.

          • SecurityGroups — (Array<String>)

            The security group names.

          • InstanceMarketOptions — (map)

            The market (purchasing) option for the instances.

            • MarketType — (String)

              The market type.

              Possible values include:
              • "spot"
            • SpotOptions — (map)

              The options for Spot Instances.

              • MaxPrice — (String)

                The maximum hourly price you're willing to pay for the Spot Instances.

              • SpotInstanceType — (String)

                The Spot Instance request type.

                Possible values include:
                • "one-time"
                • "persistent"
              • BlockDurationMinutes — (Integer)

                The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

              • ValidUntil — (Date)

                The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

              • InstanceInterruptionBehavior — (String)

                The behavior when a Spot Instance is interrupted.

                Possible values include:
                • "hibernate"
                • "stop"
                • "terminate"
          • CreditSpecification — (map)

            The credit option for CPU usage of the instance.

            • CpuCredits — (String)

              The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.

          • CpuOptions — (map)

            The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

            • CoreCount — (Integer)

              The number of CPU cores for the instance.

            • ThreadsPerCore — (Integer)

              The number of threads per CPU core.

          • CapacityReservationSpecification — (map)

            Information about the Capacity Reservation targeting option.

            • CapacityReservationPreference — (String)

              Indicates the instance's Capacity Reservation preferences. Possible preferences include:

              • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

              • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

              Possible values include:
              • "open"
              • "none"
            • CapacityReservationTarget — (map)

              Information about the target Capacity Reservation or Capacity Reservation group.

              • CapacityReservationId — (String)

                The ID of the targeted Capacity Reservation.

              • CapacityReservationResourceGroupArn — (String)

                The ARN of the targeted Capacity Reservation group.

          • LicenseSpecifications — (Array<map>)

            The license configurations.

            • LicenseConfigurationArn — (String)

              The Amazon Resource Name (ARN) of the license configuration.

          • HibernationOptions — (map)

            Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

            • Configured — (Boolean)

              If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

          • MetadataOptions — (map)

            The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

            • State — (String)

              The state of the metadata option changes.

              pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

              applied - The metadata options have been successfully applied on the instance.

              Possible values include:
              • "pending"
              • "applied"
            • HttpTokens — (String)

              The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

              If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

              If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

              Possible values include:
              • "optional"
              • "required"
            • HttpPutResponseHopLimit — (Integer)

              The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

              Default: 1

              Possible values: Integers from 1 to 64

            • HttpEndpoint — (String)

              This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

              Note: If you specify a value of disabled, you will not be able to access your instance metadata.
              Possible values include:
              • "disabled"
              • "enabled"
      • Warning — (map)

        If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

        • Errors — (Array<map>)

          The error codes and error messages.

          • Code — (String)

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.

          • Message — (String)

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRoute(params = {}, callback) ⇒ AWS.Request

Creates a static route for the specified local gateway route table.

Service Reference:

Examples:

Calling the createLocalGatewayRoute operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  LocalGatewayVirtualInterfaceGroupId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.createLocalGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR range used for destination matches. Routing decisions are based on the most specific match.

    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • LocalGatewayVirtualInterfaceGroupId — (String)

      The ID of the virtual interface group.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Route — (map)

        Information about the route.

        • DestinationCidrBlock — (String)

          The CIDR block used for destination matches.

        • LocalGatewayVirtualInterfaceGroupId — (String)

          The ID of the virtual interface group.

        • Type — (String)

          The route type.

          Possible values include:
          • "static"
          • "propagated"
        • State — (String)

          The state of the route.

          Possible values include:
          • "pending"
          • "active"
          • "blackhole"
          • "deleting"
          • "deleted"
        • LocalGatewayRouteTableId — (String)

          The ID of the local gateway route table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRouteTableVpcAssociation(params = {}, callback) ⇒ AWS.Request

Associates the specified VPC with the specified local gateway route table.

Service Reference:

Examples:

Calling the createLocalGatewayRouteTableVpcAssociation operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createLocalGatewayRouteTableVpcAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • VpcId — (String)

      The ID of the VPC.

    • TagSpecifications — (Array<map>)

      The tags to assign to the local gateway route table VPC association.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • DryRun — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVpcAssociation — (map)

        Information about the association.

        • LocalGatewayRouteTableVpcAssociationId — (String)

          The ID of the association.

        • LocalGatewayRouteTableId — (String)

          The ID of the local gateway route table.

        • LocalGatewayId — (String)

          The ID of the local gateway.

        • VpcId — (String)

          The ID of the VPC.

        • State — (String)

          The state of the association.

        • Tags — (Array<map>)

          The tags assigned to the association.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createManagedPrefixList(params = {}, callback) ⇒ AWS.Request

Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.

You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.

Service Reference:

Examples:

Calling the createManagedPrefixList operation

var params = {
  AddressFamily: 'STRING_VALUE', /* required */
  MaxEntries: 'NUMBER_VALUE', /* required */
  PrefixListName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  Entries: [
    {
      Cidr: 'STRING_VALUE', /* required */
      Description: 'STRING_VALUE'
    },
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createManagedPrefixList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • PrefixListName — (String)

      A name for the prefix list.

      Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

    • Entries — (Array<map>)

      One or more entries for the prefix list.

      • Cidr — required — (String)

        The CIDR block.

      • Description — (String)

        A description for the entry.

        Constraints: Up to 255 characters in length.

    • MaxEntries — (Integer)

      The maximum number of entries for the prefix list.

    • TagSpecifications — (Array<map>)

      The tags to apply to the prefix list during creation.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

    • AddressFamily — (String)

      The IP address type.

      Valid Values: IPv4 | IPv6

    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      Constraints: Up to 255 UTF-8 characters in length.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PrefixList — (map)

        Information about the prefix list.

        • PrefixListId — (String)

          The ID of the prefix list.

        • AddressFamily — (String)

          The IP address version.

        • State — (String)

          The state of the prefix list.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "modify-in-progress"
          • "modify-complete"
          • "modify-failed"
          • "restore-in-progress"
          • "restore-complete"
          • "restore-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"
        • StateMessage — (String)

          The state message.

        • PrefixListArn — (String)

          The Amazon Resource Name (ARN) for the prefix list.

        • PrefixListName — (String)

          The name of the prefix list.

        • MaxEntries — (Integer)

          The maximum number of entries for the prefix list.

        • Version — (Integer)

          The version of the prefix list.

        • Tags — (Array<map>)

          The tags for the prefix list.

          • 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 255 Unicode characters.

        • OwnerId — (String)

          The ID of the owner of the prefix list.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNatGateway(params = {}, callback) ⇒ AWS.Request

Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To create a NAT gateway


/* This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway. */

 var params = {
  AllocationId: "eipalloc-37fc1a52", 
  SubnetId: "subnet-1a2b3c4d"
 };
 ec2.createNatGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NatGateway: {
     CreateTime: <Date Representation>, 
     NatGatewayAddresses: [
        {
       AllocationId: "eipalloc-37fc1a52"
      }
     ], 
     NatGatewayId: "nat-08d48af2a8e83edfd", 
     State: "pending", 
     SubnetId: "subnet-1a2b3c4d", 
     VpcId: "vpc-1122aabb"
    }
   }
   */
 });

Calling the createNatGateway operation

var params = {
  AllocationId: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNatGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AllocationId — (String)

      The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

      Constraint: Maximum 64 ASCII characters.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (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.

    • SubnetId — (String)

      The subnet in which to create the NAT gateway.

    • TagSpecifications — (Array<map>)

      The tags to assign to the NAT gateway.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

      • NatGateway — (map)

        Information about the NAT gateway.

        • CreateTime — (Date)

          The date and time the NAT gateway was created.

        • DeleteTime — (Date)

          The date and time the NAT gateway was deleted, if applicable.

        • FailureCode — (String)

          If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

        • FailureMessage — (String)

          If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

          • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"

          • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"

          • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"

          • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"

          • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."

          • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

        • NatGatewayAddresses — (Array<map>)

          Information about the IP addresses and network interface associated with the NAT gateway.

          • AllocationId — (String)

            The allocation ID of the Elastic IP address that's associated with the NAT gateway.

          • NetworkInterfaceId — (String)

            The ID of the network interface associated with the NAT gateway.

          • PrivateIp — (String)

            The private IP address associated with the Elastic IP address.

          • PublicIp — (String)

            The Elastic IP address associated with the NAT gateway.

        • NatGatewayId — (String)

          The ID of the NAT gateway.

        • ProvisionedBandwidth — (map)

          Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

        • State — (String)

          The state of the NAT gateway.

          • pending: The NAT gateway is being created and is not ready to process traffic.

          • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

          • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

          • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

          • deleted: The NAT gateway has been terminated and is no longer processing traffic.

          Possible values include:
          • "pending"
          • "failed"
          • "available"
          • "deleting"
          • "deleted"
        • SubnetId — (String)

          The ID of the subnet in which the NAT gateway is located.

        • VpcId — (String)

          The ID of the VPC in which the NAT gateway is located.

        • Tags — (Array<map>)

          The tags for the NAT gateway.

          • 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 255 Unicode characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkAcl(params = {}, callback) ⇒ AWS.Request

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To create a network ACL


/* This example creates a network ACL for the specified VPC. */

 var params = {
  VpcId: "vpc-a01106c2"
 };
 ec2.createNetworkAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NetworkAcl: {
     Associations: [
     ], 
     Entries: [
        {
       CidrBlock: "0.0.0.0/0", 
       Egress: true, 
       Protocol: "-1", 
       RuleAction: "deny", 
       RuleNumber: 32767
      }, 
        {
       CidrBlock: "0.0.0.0/0", 
       Egress: false, 
       Protocol: "-1", 
       RuleAction: "deny", 
       RuleNumber: 32767
      }
     ], 
     IsDefault: false, 
     NetworkAclId: "acl-5fb85d36", 
     Tags: [
     ], 
     VpcId: "vpc-a01106c2"
    }
   }
   */
 });

Calling the createNetworkAcl operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | key-pair | launch-template | local-gateway-route-table-vpc-association | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNetworkAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (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.

    • VpcId — (String)

      The ID of the VPC.

    • TagSpecifications — (Array<map>)

      The tags to assign to the network ACL.

      • ResourceType — (String)

        The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

        To tag a resource after it has been created, see CreateTags.

        Possible values include:
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "dedicated-host"
        • "dhcp-options"
        • "egress-only-internet-gateway"
        • "elastic-ip"
        • "elastic-gpu"
        • "export-image-task"
        • "export-instance-task"
        • "fleet"
        • "fpga-image"
        • "host-reservation"
        • "image"
        • "import-image-task"
        • "import-snapshot-task"
        • "instance"
        • "internet-gateway"
        • "key-pair"
        • "launch-template"
        • "local-gateway-route-table-vpc-association"
        • "natgateway"
        • "network-acl"
        • "network-interface"
        • "placement-group"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "snapshot"
        • "spot-fleet-request"
        • "spot-instances-request"
        • "subnet"
        • "traffic-mirror-filter"
        • "traffic-mirror-session"
        • "traffic-mirror-target"
        • "transit-gateway"
        • "transit-gateway-attachment"
        • "transit-gateway-multicast-domain"
        • "transit-gateway-route-table"
        • "volume"
        • "vpc"
        • "vpc-peering-connection"
        • "vpn-connection"
        • "vpn-gateway"
        • "vpc-flow-log"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • 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 255 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkAcl — (map)

        Information about the network ACL.

        • Associations — (Array<map>)

          Any associations between the network ACL and one or more subnets

          • NetworkAclAssociationId — (String)

            The ID of the association between a network ACL and a subnet.

          • NetworkAclId — (String)

            The ID of the network ACL.

          • SubnetId — (String)

            The ID of the subnet.

        • Entries — (Array<map>)

          One or more entries (rules) in the network ACL.

          • CidrBlock — (String)

            The IPv4 network range to allow or deny, in CIDR notation.

          • Egress — (Boolean)

            Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

          • IcmpTypeCode — (map)

            ICMP protocol: The ICMP type and code.

            • Code — (Integer)

              The ICMP code. A value of -1 means all codes for the specified ICMP type.

            • Type — (Integer)

              The ICMP type. A value of -1 means all types.

          • Ipv6CidrBlock — (String)

            The IPv6 network range to allow or deny, in CIDR notation.

          • PortRange — (map)

            TCP or UDP protocols: The range of ports the rule applies to.

            • From — (Integer)

              The first port in the range.

            • To — (Integer)

              The last port in the range.

          • Protocol — (String)

            The protocol number. A value of "-1" means all protocols.

          • RuleAction — (String)

            Indicates whether to allow or deny the traffic that matches the rule.

            Possible values include:
            • "allow"
            • "deny"
          • RuleNumber — (Integer)

            The rule number for the entry. ACL entries are processed in ascending order by rule number.

        • IsDefault — (Boolean)

          Indicates whether this is the default network ACL for the VPC.

        • NetworkAclId — (String)

          The ID of the network ACL.

        • Tags — (Array<map>)

          Any tags assigned to the network ACL.

          • 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 255 Unicode characters.

        • VpcId — (String)

          The ID of the VPC for the network ACL.

        • OwnerId — (String)

          The ID of the AWS account that owns the network ACL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkAclEntry(params = {}, callback) ⇒ AWS.Request

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Service Reference:

Examples:

To create a network ACL entry


/* This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet. */

 var params = {
  CidrBlock: "0.0.0.0/0", 
  Egress: false, 
  NetworkAclId: "acl-5fb85d36", 
  PortRange: {
   From: 53, 
   To: 53
  }, 
  Protocol: "17", 
  RuleAction: "allow", 
  RuleNumber: 100
 };
 ec2.createNetworkAclEntry(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the createNetworkAclEntry operation

var params = {
  Egress: true || false, /* required */
  NetworkAclId: 'STRING_VALUE', /* required */
  Protocol: 'STRING_VALUE', /* required */
  RuleAction: allow | deny, /* required */
  RuleNumber: 'NUMBER_VALUE', /* required */
  CidrBlock: 'STRING_VALUE',
  DryRun: true || false,
  IcmpTypeCode: {
    Code: 'NUMBER_VALUE',
    Type: 'NUMBER_VALUE'
  },
  Ipv6CidrBlock: 'STRING_VALUE',
  PortRange: {
    From: 'NUMBER_VALUE',
    To: 'NUMBER_VALUE'
  }
};
ec2.createNetworkAclEntry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CidrBlock — (String)

      The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

    • DryRun — (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.

    • Egress — (Boolean)

      Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

    • IcmpTypeCode — (map)

      ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

      • Code — (Integer)

        The ICMP code. A value of -1 means all codes for the specified ICMP type.

      • Type — (Integer)

        The ICMP type. A value of -1 means all types.

    • Ipv6CidrBlock — (String)

      The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

    • NetworkAclId — (String)

      The ID of the network ACL.

    • PortRange — (map)

      TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

      • From — (Integer)

        The first port in the range.

      • To — (Integer)

        The last port in the range.

    • Protocol — (String)

      The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

    • RuleAction — (String)

      Indicates whether to allow or deny the traffic that matches the rule.

      Possible values include:
      • "allow"
      • "deny"
    • RuleNumber — (Integer)

      The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

      Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation reque