We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.VPCLattice

Inherits:
AWS.Service show all
Identifier:
vpclattice
API Version:
2022-11-30
Defined in:
(unknown)

Overview

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

Service Description

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide

Sending a Request Using VPCLattice

var vpclattice = new AWS.VPCLattice();
vpclattice.createTargetGroup(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 VPCLattice object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var vpclattice = new AWS.VPCLattice({apiVersion: '2022-11-30'});

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

AWS.config.apiVersions = {
  vpclattice: '2022-11-30',
  // other service API versions
};

var vpclattice = new AWS.VPCLattice();

Version:

  • 2022-11-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a VPCLattice object

var vpclattice = new AWS.VPCLattice({apiVersion: '2022-11-30'});

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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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.VPCLattice.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.VPCLattice.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. The function is only called for retryable errors.
  • 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'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

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

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

Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

Required permissions: vpc-lattice:UpdateRule

For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the batchUpdateRule operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  rules: [ /* required */
    {
      ruleIdentifier: 'STRING_VALUE', /* required */
      action: {
        fixedResponse: {
          statusCode: 'NUMBER_VALUE' /* required */
        },
        forward: {
          targetGroups: [ /* required */
            {
              targetGroupIdentifier: 'STRING_VALUE', /* required */
              weight: 'NUMBER_VALUE'
            },
            /* more items */
          ]
        }
      },
      match: {
        httpMatch: {
          headerMatches: [
            {
              match: { /* required */
                contains: 'STRING_VALUE',
                exact: 'STRING_VALUE',
                prefix: 'STRING_VALUE'
              },
              name: 'STRING_VALUE', /* required */
              caseSensitive: true || false
            },
            /* more items */
          ],
          method: 'STRING_VALUE',
          pathMatch: {
            match: { /* required */
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE'
            },
            caseSensitive: true || false
          }
        }
      },
      priority: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.batchUpdateRule(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • rules — (Array<map>)

      The rules for the specified listener.

      • action — (map)

        The rule action.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • match — (map)

        The rule match.

        • httpMatch — (map)

          The HTTP criteria that a rule must match.

          • headerMatches — (Array<map>)

            The header matches. Matches incoming requests with rule based on request header value before applying rule action.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The header match type.

              • contains — (String)

                A contains type match.

              • exact — (String)

                An exact type match.

              • prefix — (String)

                A prefix type match. Matches the value with the prefix.

            • namerequired — (String)

              The name of the header.

          • method — (String)

            The HTTP method type.

          • pathMatch — (map)

            The path match.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The type of path match.

              • exact — (String)

                An exact match of the path.

              • prefix — (String)

                A prefix match of the path.

      • priority — (Integer)

        The rule priority. A listener can't have multiple rules with the same priority.

      • ruleIdentifierrequired — (String)

        The ID or Amazon Resource Name (ARN) of the rule.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • successful — (Array<map>)

        The rules that were successfully updated.

        • action — (map)

          The action for the rule.

          • fixedResponse — (map)

            The fixed response action. The rule returns a custom HTTP response.

            • statusCoderequired — (Integer)

              The HTTP response code.

          • forward — (map)

            The forward action. Traffic that matches the rule is forwarded to the specified target groups.

            • targetGroupsrequired — (Array<map>)

              The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

              The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

              • targetGroupIdentifierrequired — (String)

                The ID or Amazon Resource Name (ARN) of the target group.

              • weight — (Integer)

                Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

        • arn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • id — (String)

          The ID of the listener.

        • isDefault — (Boolean)

          Indicates whether this is the default rule.

        • match — (map)

          The rule match.

          • httpMatch — (map)

            The HTTP criteria that a rule must match.

            • headerMatches — (Array<map>)

              The header matches. Matches incoming requests with rule based on request header value before applying rule action.

              • caseSensitive — (Boolean)

                Indicates whether the match is case sensitive.

              • matchrequired — (map)

                The header match type.

                • contains — (String)

                  A contains type match.

                • exact — (String)

                  An exact type match.

                • prefix — (String)

                  A prefix type match. Matches the value with the prefix.

              • namerequired — (String)

                The name of the header.

            • method — (String)

              The HTTP method type.

            • pathMatch — (map)

              The path match.

              • caseSensitive — (Boolean)

                Indicates whether the match is case sensitive.

              • matchrequired — (map)

                The type of path match.

                • exact — (String)

                  An exact match of the path.

                • prefix — (String)

                  A prefix match of the path.

        • name — (String)

          The name of the listener.

        • priority — (Integer)

          The rule priority.

      • unsuccessful — (Array<map>)

        The rules that the operation couldn't update.

        • failureCode — (String)

          The failure code.

        • failureMessage — (String)

          The failure message.

        • ruleIdentifier — (String)

          The ID or Amazon Resource Name (ARN) of the rule.

Returns:

  • (AWS.Request)

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

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

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createAccessLogSubscription operation

var params = {
  destinationArn: 'STRING_VALUE', /* required */
  resourceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createAccessLogSubscription(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)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • destinationArn — (String)

      The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.

    • resourceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network or service.

    • tags — (map<String>)

      The tags for the access log subscription.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the access log subscription.

      • destinationArn — (String)

        The Amazon Resource Name (ARN) of the log destination.

      • id — (String)

        The ID of the access log subscription.

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the service network or service.

      • resourceId — (String)

        The ID of the service network or service.

Returns:

  • (AWS.Request)

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

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

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createListener operation

var params = {
  defaultAction: { /* required */
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  name: 'STRING_VALUE', /* required */
  protocol: HTTP | HTTPS | TLS_PASSTHROUGH, /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  port: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createListener(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)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • defaultAction — (map)

      The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.

      • fixedResponse — (map)

        The fixed response action. The rule returns a custom HTTP response.

        • statusCoderequired — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroupsrequired — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

          • targetGroupIdentifierrequired — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • name — (String)

      The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • port — (Integer)

      The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

    • protocol — (String)

      The listener protocol.

      Possible values include:
      • "HTTP"
      • "HTTPS"
      • "TLS_PASSTHROUGH"
    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

    • tags — (map<String>)

      The tags for the listener.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • defaultAction — (map)

        The action for the default rule.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • id — (String)

        The ID of the listener.

      • name — (String)

        The name of the listener.

      • port — (Integer)

        The port number of the listener.

      • protocol — (String)

        The protocol of the listener.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TLS_PASSTHROUGH"
      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service.

      • serviceId — (String)

        The ID of the service.

Returns:

  • (AWS.Request)

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

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

Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createRule operation

var params = {
  action: { /* required */
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  listenerIdentifier: 'STRING_VALUE', /* required */
  match: { /* required */
    httpMatch: {
      headerMatches: [
        {
          match: { /* required */
            contains: 'STRING_VALUE',
            exact: 'STRING_VALUE',
            prefix: 'STRING_VALUE'
          },
          name: 'STRING_VALUE', /* required */
          caseSensitive: true || false
        },
        /* more items */
      ],
      method: 'STRING_VALUE',
      pathMatch: {
        match: { /* required */
          exact: 'STRING_VALUE',
          prefix: 'STRING_VALUE'
        },
        caseSensitive: true || false
      }
    }
  },
  name: 'STRING_VALUE', /* required */
  priority: 'NUMBER_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createRule(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: {})
    • action — (map)

      The action for the default rule.

      • fixedResponse — (map)

        The fixed response action. The rule returns a custom HTTP response.

        • statusCoderequired — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroupsrequired — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

          • targetGroupIdentifierrequired — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • match — (map)

      The rule match.

      • httpMatch — (map)

        The HTTP criteria that a rule must match.

        • headerMatches — (Array<map>)

          The header matches. Matches incoming requests with rule based on request header value before applying rule action.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive.

          • matchrequired — (map)

            The header match type.

            • contains — (String)

              A contains type match.

            • exact — (String)

              An exact type match.

            • prefix — (String)

              A prefix type match. Matches the value with the prefix.

          • namerequired — (String)

            The name of the header.

        • method — (String)

          The HTTP method type.

        • pathMatch — (map)

          The path match.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive.

          • matchrequired — (map)

            The type of path match.

            • exact — (String)

              An exact match of the path.

            • prefix — (String)

              A prefix match of the path.

    • name — (String)

      The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • priority — (Integer)

      The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

    • tags — (map<String>)

      The tags for the rule.

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:

      • action — (map)

        The rule action.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • arn — (String)

        The Amazon Resource Name (ARN) of the rule.

      • id — (String)

        The ID of the rule.

      • match — (map)

        The rule match. The RuleMatch must be an HttpMatch. This means that the rule should be an exact match on HTTP constraints which are made up of the HTTP method, path, and header.

        • httpMatch — (map)

          The HTTP criteria that a rule must match.

          • headerMatches — (Array<map>)

            The header matches. Matches incoming requests with rule based on request header value before applying rule action.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The header match type.

              • contains — (String)

                A contains type match.

              • exact — (String)

                An exact type match.

              • prefix — (String)

                A prefix type match. Matches the value with the prefix.

            • namerequired — (String)

              The name of the header.

          • method — (String)

            The HTTP method type.

          • pathMatch — (map)

            The path match.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The type of path match.

              • exact — (String)

                An exact match of the path.

              • prefix — (String)

                A prefix match of the path.

      • name — (String)

        The name of the rule.

      • priority — (Integer)

        The priority assigned to the rule. The lower the priority number the higher the priority.

Returns:

  • (AWS.Request)

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

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

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createService operation

var params = {
  name: 'STRING_VALUE', /* required */
  authType: NONE | AWS_IAM,
  certificateArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  customDomainName: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createService(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: {})
    • authType — (String)

      The type of IAM policy.

      • NONE: The resource does not use an IAM policy. This is the default.

      • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • certificateArn — (String)

      The Amazon Resource Name (ARN) of the certificate.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • customDomainName — (String)

      The custom domain name of the service.

    • name — (String)

      The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • tags — (map<String>)

      The tags for the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        The public DNS name of the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • id — (String)

        The ID of the service.

      • name — (String)

        The name of the service.

      • status — (String)

        The status. If the status is CREATE_FAILED, you must delete and recreate the service.

        Possible values include:
        • "ACTIVE"
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createServiceNetwork operation

var params = {
  name: 'STRING_VALUE', /* required */
  authType: NONE | AWS_IAM,
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetwork(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: {})
    • authType — (String)

      The type of IAM policy.

      • NONE: The resource does not use an IAM policy. This is the default.

      • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • name — (String)

      The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • tags — (map<String>)

      The tags for the service network.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • id — (String)

        The ID of the service network.

      • name — (String)

        The name of the service network.

Returns:

  • (AWS.Request)

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

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

Associates a service with a service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

Examples:

Calling the createServiceNetworkServiceAssociation operation

var params = {
  serviceIdentifier: 'STRING_VALUE', /* required */
  serviceNetworkIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetworkServiceAssociation(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)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts.

    • tags — (map<String>)

      The tags for the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdBy — (String)

        The account that created the association.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        The DNS name of the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • id — (String)

        The ID of the association.

      • status — (String)

        The association status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.

As a result of this operation, the association gets created in the service network account and the VPC owner account.

If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Examples:

Calling the createServiceNetworkVpcAssociation operation

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE', /* required */
  vpcIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetworkVpcAssociation(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)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • securityGroupIds — (Array<String>)

      The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.

    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN when the resources specified in the operation are in different accounts.

    • tags — (map<String>)

      The tags for the association.

    • vpcIdentifier — (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. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdBy — (String)

        The account that created the association.

      • id — (String)

        The ID of the association.

      • securityGroupIds — (Array<String>)

        The IDs of the security groups.

      • status — (String)

        The association status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the createTargetGroup operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: IP | LAMBDA | INSTANCE | ALB, /* required */
  clientToken: 'STRING_VALUE',
  config: {
    healthCheck: {
      enabled: true || false,
      healthCheckIntervalSeconds: 'NUMBER_VALUE',
      healthCheckTimeoutSeconds: 'NUMBER_VALUE',
      healthyThresholdCount: 'NUMBER_VALUE',
      matcher: {
        httpCode: 'STRING_VALUE'
      },
      path: 'STRING_VALUE',
      port: 'NUMBER_VALUE',
      protocol: HTTP | HTTPS | TCP,
      protocolVersion: HTTP1 | HTTP2,
      unhealthyThresholdCount: 'NUMBER_VALUE'
    },
    ipAddressType: IPV4 | IPV6,
    lambdaEventStructureVersion: V1 | V2,
    port: 'NUMBER_VALUE',
    protocol: HTTP | HTTPS | TCP,
    protocolVersion: HTTP1 | HTTP2 | GRPC,
    vpcIdentifier: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createTargetGroup(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)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      If a token is not provided, the SDK will use a version 4 UUID.
    • config — (map)

      The target group configuration.

      • healthCheck — (map)

        The health check configuration. Not supported if the target group type is LAMBDA or ALB.

        • enabled — (Boolean)

          Indicates whether health checking is enabled.

        • healthCheckIntervalSeconds — (Integer)

          The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

        • healthCheckTimeoutSeconds — (Integer)

          The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

        • healthyThresholdCount — (Integer)

          The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

        • matcher — (map)

          The codes to use when checking for a successful response from a target.

          • httpCode — (String)

            The HTTP code to use when checking for a successful response from a target.

        • path — (String)

          The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

        • port — (Integer)

          The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

        • protocol — (String)

          The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • protocolVersion — (String)

          The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
        • unhealthyThresholdCount — (Integer)

          The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

      • ipAddressType — (String)

        The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

        Possible values include:
        • "IPV4"
        • "IPV6"
      • lambdaEventStructureVersion — (String)

        The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

        Possible values include:
        • "V1"
        • "V2"
      • port — (Integer)

        The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

      • protocol — (String)

        The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
      • protocolVersion — (String)

        The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

        Possible values include:
        • "HTTP1"
        • "HTTP2"
        • "GRPC"
      • vpcIdentifier — (String)

        The ID of the VPC. Not supported if the target group type is LAMBDA.

    • name — (String)

      The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • tags — (map<String>)

      The tags for the target group.

    • type — (String)

      The type of target group.

      Possible values include:
      • "IP"
      • "LAMBDA"
      • "INSTANCE"
      • "ALB"

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the target group.

      • config — (map)

        The target group configuration.

        • healthCheck — (map)

          The health check configuration. Not supported if the target group type is LAMBDA or ALB.

          • enabled — (Boolean)

            Indicates whether health checking is enabled.

          • healthCheckIntervalSeconds — (Integer)

            The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

          • healthCheckTimeoutSeconds — (Integer)

            The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

          • healthyThresholdCount — (Integer)

            The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

          • matcher — (map)

            The codes to use when checking for a successful response from a target.

            • httpCode — (String)

              The HTTP code to use when checking for a successful response from a target.

          • path — (String)

            The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

          • port — (Integer)

            The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

          • protocol — (String)

            The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • protocolVersion — (String)

            The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

            Possible values include:
            • "HTTP1"
            • "HTTP2"
          • unhealthyThresholdCount — (Integer)

            The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

        • ipAddressType — (String)

          The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • lambdaEventStructureVersion — (String)

          The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

          Possible values include:
          • "V1"
          • "V2"
        • port — (Integer)

          The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

        • protocol — (String)

          The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • protocolVersion — (String)

          The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
          • "GRPC"
        • vpcIdentifier — (String)

          The ID of the VPC. Not supported if the target group type is LAMBDA.

      • id — (String)

        The ID of the target group.

      • name — (String)

        The name of the target group.

      • status — (String)

        The status. You can retry the operation if the status is CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change in the status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
      • type — (String)

        The type of target group.

        Possible values include:
        • "IP"
        • "LAMBDA"
        • "INSTANCE"
        • "ALB"

Returns:

  • (AWS.Request)

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

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

Deletes the specified access log subscription.

Service Reference:

Examples:

Calling the deleteAccessLogSubscription operation

var params = {
  accessLogSubscriptionIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteAccessLogSubscription(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: {})
    • accessLogSubscriptionIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the access log subscription.

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.

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

Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.

Service Reference:

Examples:

Calling the deleteAuthPolicy operation

var params = {
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteAuthPolicy(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: {})
    • resourceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the resource.

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.

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

Deletes the specified listener.

Service Reference:

Examples:

Calling the deleteListener operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteListener(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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.

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

Deletes the specified resource policy.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.deleteResourcePolicy(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

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.

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

Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule.

For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the deleteRule operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  ruleIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteRule(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • ruleIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the rule.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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.

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

Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the deleteService operation

var params = {
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteService(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: {})
    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • id — (String)

        The ID of the service.

      • name — (String)

        The name of the service.

      • status — (String)

        The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

        Possible values include:
        • "ACTIVE"
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the deleteServiceNetwork operation

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetwork(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: {})
    • serviceNetworkIdentifier — (String)

      The Amazon Resource Name (ARN) or ID of the service network.

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.

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

Deletes the association between a specified service and the specific service network. This operation fails if an association is still in progress.

Examples:

Calling the deleteServiceNetworkServiceAssociation operation

var params = {
  serviceNetworkServiceAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetworkServiceAssociation(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: {})
    • serviceNetworkServiceAssociationIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • id — (String)

        The ID of the association.

      • status — (String)

        The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change in the status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.

Examples:

Calling the deleteServiceNetworkVpcAssociation operation

var params = {
  serviceNetworkVpcAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetworkVpcAssociation(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: {})
    • serviceNetworkVpcAssociationIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • id — (String)

        The ID of the association.

      • status — (String)

        The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change in the status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.

Service Reference:

Examples:

Calling the deleteTargetGroup operation

var params = {
  targetGroupIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteTargetGroup(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: {})
    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target 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. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Name (ARN) of the target group.

      • id — (String)

        The ID of the target group.

      • status — (String)

        The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Deregisters the specified targets from the specified target group.

Service Reference:

Examples:

Calling the deregisterTargets operation

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  targets: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.deregisterTargets(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: {})
    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target group.

    • targets — (Array<map>)

      The targets to deregister.

      • idrequired — (String)

        The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

      • successful — (Array<map>)

        The targets that were successfully deregistered.

        • idrequired — (String)

          The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

        • port — (Integer)

          The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

      • unsuccessful — (Array<map>)

        The targets that the operation couldn't deregister.

        • failureCode — (String)

          The failure code.

        • failureMessage — (String)

          The failure message.

        • id — (String)

          The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

        • port — (Integer)

          The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified access log subscription.

Service Reference:

Examples:

Calling the getAccessLogSubscription operation

var params = {
  accessLogSubscriptionIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getAccessLogSubscription(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: {})
    • accessLogSubscriptionIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the access log subscription.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the access log subscription.

      • createdAt — (Date)

        The date and time that the access log subscription was created, specified in ISO-8601 format.

      • destinationArn — (String)

        The Amazon Resource Name (ARN) of the access log destination.

      • id — (String)

        The ID of the access log subscription.

      • lastUpdatedAt — (Date)

        The date and time that the access log subscription was last updated, specified in ISO-8601 format.

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the service network or service.

      • resourceId — (String)

        The ID of the service network or service.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the auth policy for the specified service or service network.

Service Reference:

Examples:

Calling the getAuthPolicy operation

var params = {
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getAuthPolicy(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: {})
    • resourceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network or service.

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:

      • createdAt — (Date)

        The date and time that the auth policy was created, specified in ISO-8601 format.

      • lastUpdatedAt — (Date)

        The date and time that the auth policy was last updated, specified in ISO-8601 format.

      • policy — (String)

        The auth policy.

      • state — (String)

        The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is NONE, then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

        Possible values include:
        • "Active"
        • "Inactive"

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified listener for the specified service.

Service Reference:

Examples:

Calling the getListener operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getListener(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • createdAt — (Date)

        The date and time that the listener was created, specified in ISO-8601 format.

      • defaultAction — (map)

        The actions for the default listener rule.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • id — (String)

        The ID of the listener.

      • lastUpdatedAt — (Date)

        The date and time that the listener was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the listener.

      • port — (Integer)

        The listener port.

      • protocol — (String)

        The listener protocol.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TLS_PASSTHROUGH"
      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service.

      • serviceId — (String)

        The ID of the service.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.

Service Reference:

Examples:

Calling the getResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.getResourcePolicy(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the service network or service.

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:

      • policy — (String)

        An IAM policy.

Returns:

  • (AWS.Request)

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

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

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the getRule operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  ruleIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getRule(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • ruleIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener rule.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • action — (map)

        The action for the default rule.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • createdAt — (Date)

        The date and time that the listener rule was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the listener.

      • isDefault — (Boolean)

        Indicates whether this is the default rule.

      • lastUpdatedAt — (Date)

        The date and time that the listener rule was last updated, specified in ISO-8601 format.

      • match — (map)

        The rule match.

        • httpMatch — (map)

          The HTTP criteria that a rule must match.

          • headerMatches — (Array<map>)

            The header matches. Matches incoming requests with rule based on request header value before applying rule action.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The header match type.

              • contains — (String)

                A contains type match.

              • exact — (String)

                An exact type match.

              • prefix — (String)

                A prefix type match. Matches the value with the prefix.

            • namerequired — (String)

              The name of the header.

          • method — (String)

            The HTTP method type.

          • pathMatch — (map)

            The path match.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The type of path match.

              • exact — (String)

                An exact match of the path.

              • prefix — (String)

                A prefix match of the path.

      • name — (String)

        The name of the listener.

      • priority — (Integer)

        The priority level for the specified rule.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified service.

Service Reference:

Examples:

Calling the getService operation

var params = {
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getService(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: {})
    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate.

      • createdAt — (Date)

        The date and time that the service was created, specified in ISO-8601 format.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        The DNS name of the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the service.

      • lastUpdatedAt — (Date)

        The date and time that the service was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the service.

      • status — (String)

        The status of the service.

        Possible values include:
        • "ACTIVE"
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified service network.

Service Reference:

Examples:

Calling the getServiceNetwork operation

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetwork(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: {})
    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • createdAt — (Date)

        The date and time that the service network was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the service network.

      • lastUpdatedAt — (Date)

        The date and time of the last update, specified in ISO-8601 format.

      • name — (String)

        The name of the service network.

      • numberOfAssociatedServices — (Integer)

        The number of services associated with the service network.

      • numberOfAssociatedVPCs — (Integer)

        The number of VPCs associated with the service network.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified association between a service network and a service.

Examples:

Calling the getServiceNetworkServiceAssociation operation

var params = {
  serviceNetworkServiceAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetworkServiceAssociation(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: {})
    • serviceNetworkServiceAssociationIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdAt — (Date)

        The date and time that the association was created, specified in ISO-8601 format.

      • createdBy — (String)

        The account that created the association.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        The DNS name of the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the service network and service association.

      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service.

      • serviceId — (String)

        The ID of the service.

      • serviceName — (String)

        The name of the service.

      • serviceNetworkArn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • serviceNetworkId — (String)

        The ID of the service network.

      • serviceNetworkName — (String)

        The name of the service network.

      • status — (String)

        The status of the association.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

Retrieves information about the association between a service network and a VPC.

Service Reference:

Examples:

Calling the getServiceNetworkVpcAssociation operation

var params = {
  serviceNetworkVpcAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetworkVpcAssociation(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: {})
    • serviceNetworkVpcAssociationIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdAt — (Date)

        The date and time that the association was created, specified in ISO-8601 format.

      • createdBy — (String)

        The account that created the association.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the specified association between the service network and the VPC.

      • lastUpdatedAt — (Date)

        The date and time that the association was last updated, specified in ISO-8601 format.

      • securityGroupIds — (Array<String>)

        The IDs of the security groups.

      • serviceNetworkArn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • serviceNetworkId — (String)

        The ID of the service network.

      • serviceNetworkName — (String)

        The name of the service network.

      • status — (String)

        The status of the association.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • vpcId — (String)

        The ID of the VPC.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the specified target group.

Service Reference:

Examples:

Calling the getTargetGroup operation

var params = {
  targetGroupIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getTargetGroup(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: {})
    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target 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. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Name (ARN) of the target group.

      • config — (map)

        The target group configuration.

        • healthCheck — (map)

          The health check configuration. Not supported if the target group type is LAMBDA or ALB.

          • enabled — (Boolean)

            Indicates whether health checking is enabled.

          • healthCheckIntervalSeconds — (Integer)

            The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

          • healthCheckTimeoutSeconds — (Integer)

            The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

          • healthyThresholdCount — (Integer)

            The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

          • matcher — (map)

            The codes to use when checking for a successful response from a target.

            • httpCode — (String)

              The HTTP code to use when checking for a successful response from a target.

          • path — (String)

            The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

          • port — (Integer)

            The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

          • protocol — (String)

            The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • protocolVersion — (String)

            The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

            Possible values include:
            • "HTTP1"
            • "HTTP2"
          • unhealthyThresholdCount — (Integer)

            The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

        • ipAddressType — (String)

          The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • lambdaEventStructureVersion — (String)

          The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

          Possible values include:
          • "V1"
          • "V2"
        • port — (Integer)

          The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

        • protocol — (String)

          The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • protocolVersion — (String)

          The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
          • "GRPC"
        • vpcIdentifier — (String)

          The ID of the VPC. Not supported if the target group type is LAMBDA.

      • createdAt — (Date)

        The date and time that the target group was created, specified in ISO-8601 format.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the target group.

      • lastUpdatedAt — (Date)

        The date and time that the target group was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the target group.

      • serviceArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the service.

      • status — (String)

        The status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
      • type — (String)

        The target group type.

        Possible values include:
        • "IP"
        • "LAMBDA"
        • "INSTANCE"
        • "ALB"

Returns:

  • (AWS.Request)

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

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

Lists all access log subscriptions for the specified service network or service.

Service Reference:

Examples:

Calling the listAccessLogSubscriptions operation

var params = {
  resourceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listAccessLogSubscriptions(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • resourceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network or service.

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:

      • items — (Array<map>)

        Information about the access log subscriptions.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the access log subscription

        • createdAtrequired — (Date)

          The date and time that the access log subscription was created, specified in ISO-8601 format.

        • destinationArnrequired — (String)

          The Amazon Resource Name (ARN) of the destination.

        • idrequired — (String)

          The ID of the access log subscription.

        • lastUpdatedAtrequired — (Date)

          The date and time that the access log subscription was last updated, specified in ISO-8601 format.

        • resourceArnrequired — (String)

          The Amazon Resource Name (ARN) of the service or service network.

        • resourceIdrequired — (String)

          The ID of the service or service network.

      • nextToken — (String)

        A pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the listeners for the specified service.

Service Reference:

Examples:

Calling the listListeners operation

var params = {
  serviceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listListeners(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • items — (Array<map>)

        Information about the listeners.

        • arn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • createdAt — (Date)

          The date and time that the listener was created, specified in ISO-8601 format.

        • id — (String)

          The ID of the listener.

        • lastUpdatedAt — (Date)

          The date and time that the listener was last updated, specified in ISO-8601 format.

        • name — (String)

          The name of the listener.

        • port — (Integer)

          The listener port.

        • protocol — (String)

          The listener protocol.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TLS_PASSTHROUGH"
      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the rules for the listener.

Service Reference:

Examples:

Calling the listRules operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listRules(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: {})
    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • items — (Array<map>)

        Information about the rules.

        • arn — (String)

          The Amazon Resource Name (ARN) of the rule.

        • createdAt — (Date)

          The date and time that the listener rule was created, specified in ISO-8601 format.

        • id — (String)

          The ID of the rule.

        • isDefault — (Boolean)

          Indicates whether this is the default listener rule.

        • lastUpdatedAt — (Date)

          The date and time that the listener rule was last updated, specified in ISO-8601 format.

        • name — (String)

          The name of the rule.

        • priority — (Integer)

          The priority of the rule.

      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.

Service Reference:

Examples:

Calling the listServiceNetworks operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listServiceNetworks(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

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:

      • items — (Array<map>)

        Information about the service networks.

        • arn — (String)

          The Amazon Resource Name (ARN) of the service network.

        • createdAt — (Date)

          The date and time that the service network was created, specified in ISO-8601 format.

        • id — (String)

          The ID of the service network.

        • lastUpdatedAt — (Date)

          The date and time that the service network was last updated, specified in ISO-8601 format.

        • name — (String)

          The name of the service network.

        • numberOfAssociatedServices — (Integer)

          The number of services associated with the service network.

        • numberOfAssociatedVPCs — (Integer)

          The number of VPCs associated with the service network.

      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource that is shared with another account, the association includes the local account ID as the prefix in the ARN for each account the resource is shared with.

Examples:

Calling the listServiceNetworkServiceAssociations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serviceIdentifier: 'STRING_VALUE',
  serviceNetworkIdentifier: 'STRING_VALUE'
};
vpclattice.listServiceNetworkServiceAssociations(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network.

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:

      • items — (Array<map>)

        Information about the associations.

        • arn — (String)

          The Amazon Resource Name (ARN) of the association.

        • createdAt — (Date)

          The date and time that the association was created, specified in ISO-8601 format.

        • createdBy — (String)

          The account that created the association.

        • customDomainName — (String)

          The custom domain name of the service.

        • dnsEntry — (map)

          The DNS information.

          • domainName — (String)

            The domain name of the service.

          • hostedZoneId — (String)

            The ID of the hosted zone.

        • id — (String)

          The ID of the association.

        • serviceArn — (String)

          The Amazon Resource Name (ARN) of the service.

        • serviceId — (String)

          The ID of the service.

        • serviceName — (String)

          The name of the service.

        • serviceNetworkArn — (String)

          The Amazon Resource Name (ARN) of the service network.

        • serviceNetworkId — (String)

          The ID of the service network.

        • serviceNetworkName — (String)

          The name of the service network.

        • status — (String)

          The status. If the deletion fails, try to delete again.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Examples:

Calling the listServiceNetworkVpcAssociations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serviceNetworkIdentifier: 'STRING_VALUE',
  vpcIdentifier: 'STRING_VALUE'
};
vpclattice.listServiceNetworkVpcAssociations(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network.

    • vpcIdentifier — (String)

      The ID or Amazon Resource Name (ARN) 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. The data object has the following properties:

      • items — (Array<map>)

        Information about the associations.

        • arn — (String)

          The Amazon Resource Name (ARN) of the association.

        • createdAt — (Date)

          The date and time that the association was created, specified in ISO-8601 format.

        • createdBy — (String)

          The account that created the association.

        • id — (String)

          The ID of the association.

        • lastUpdatedAt — (Date)

          The date and time that the association was last updated, specified in ISO-8601 format.

        • serviceNetworkArn — (String)

          The Amazon Resource Name (ARN) of the service network.

        • serviceNetworkId — (String)

          The ID of the service network.

        • serviceNetworkName — (String)

          The name of the service network.

        • status — (String)

          The status.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
          • "UPDATE_FAILED"
        • vpcId — (String)

          The ID of the VPC.

      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the services owned by the caller account or shared with the caller account.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listServices(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

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:

      • items — (Array<map>)

        Information about the services.

        • arn — (String)

          The Amazon Resource Name (ARN) of the service.

        • createdAt — (Date)

          The date and time that the service was created, specified in ISO-8601 format.

        • customDomainName — (String)

          The custom domain name of the service.

        • dnsEntry — (map)

          The DNS information.

          • domainName — (String)

            The domain name of the service.

          • hostedZoneId — (String)

            The ID of the hosted zone.

        • id — (String)

          The ID of the service.

        • lastUpdatedAt — (Date)

          The date and time that the service was last updated. The format is ISO-8601.

        • name — (String)

          The name of the service.

        • status — (String)

          The status.

          Possible values include:
          • "ACTIVE"
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.listTagsForResource(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

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:

      • tags — (map<String>)

        Information about the tags.

Returns:

  • (AWS.Request)

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

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

Lists your target groups. You can narrow your search by using the filters below in your request.

Service Reference:

Examples:

Calling the listTargetGroups operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  targetGroupType: IP | LAMBDA | INSTANCE | ALB,
  vpcIdentifier: 'STRING_VALUE'
};
vpclattice.listTargetGroups(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • targetGroupType — (String)

      The target group type.

      Possible values include:
      • "IP"
      • "LAMBDA"
      • "INSTANCE"
      • "ALB"
    • vpcIdentifier — (String)

      The ID or Amazon Resource Name (ARN) 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. The data object has the following properties:

      • items — (Array<map>)

        Information about the target groups.

        • arn — (String)

          The ARN (Amazon Resource Name) of the target group.

        • createdAt — (Date)

          The date and time that the target group was created, specified in ISO-8601 format.

        • id — (String)

          The ID of the target group.

        • ipAddressType — (String)

          The type of IP address used for the target group. The possible values are IPV4 and IPV6. This is an optional parameter. If not specified, the default is IPV4.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • lambdaEventStructureVersion — (String)

          The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.

          Possible values include:
          • "V1"
          • "V2"
        • lastUpdatedAt — (Date)

          The date and time that the target group was last updated, specified in ISO-8601 format.

        • name — (String)

          The name of the target group.

        • port — (Integer)

          The port of the target group.

        • protocol — (String)

          The protocol of the target group.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • serviceArns — (Array<String>)

          The Amazon Resource Names (ARNs) of the service.

        • status — (String)

          The status.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • type — (String)

          The target group type.

          Possible values include:
          • "IP"
          • "LAMBDA"
          • "INSTANCE"
          • "ALB"
        • vpcIdentifier — (String)

          The ID of the VPC of the target group.

      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.

Service Reference:

Examples:

Calling the listTargets operation

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  targets: [
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.listTargets(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: {})
    • maxResults — (Integer)

      The maximum number of results to return.

    • nextToken — (String)

      A pagination token for the next page of results.

    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target group.

    • targets — (Array<map>)

      The targets.

      • idrequired — (String)

        The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

      • items — (Array<map>)

        Information about the targets.

        • id — (String)

          The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target type is ALB, this is the ARN of an Application Load Balancer.

        • port — (Integer)

          The port on which the target is listening.

        • reasonCode — (String)

          The code for why the target status is what it is.

        • status — (String)

          The status of the target.

          • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

          • UNAVAILABLE: Health checks are unavailable for the target group.

          • HEALTHY: The target is healthy.

          • UNHEALTHY: The target is unhealthy.

          • INITIAL: Initial health checks on the target are being performed.

          • UNUSED: Target group is not used in a service.

          Possible values include:
          • "DRAINING"
          • "UNAVAILABLE"
          • "HEALTHY"
          • "UNHEALTHY"
          • "INITIAL"
          • "UNUSED"
      • nextToken — (String)

        If there are additional results, a pagination token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.

For more information, see Auth policies in the Amazon VPC Lattice User Guide.

Service Reference:

Examples:

Calling the putAuthPolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.putAuthPolicy(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: {})
    • policy — (String)

      The auth policy. The policy string in JSON must not contain newlines or blank lines.

    • resourceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.

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:

      • policy — (String)

        The auth policy. The policy string in JSON must not contain newlines or blank lines.

      • state — (String)

        The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is NONE, then, any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

        Possible values include:
        • "Active"
        • "Inactive"

Returns:

  • (AWS.Request)

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

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

Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.putResourcePolicy(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: {})
    • policy — (String)

      An IAM policy. The policy string in JSON must not contain newlines or blank lines.

    • resourceArn — (String)

      The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.

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.

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

Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

Service Reference:

Examples:

Calling the registerTargets operation

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  targets: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.registerTargets(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: {})
    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target group.

    • targets — (Array<map>)

      The targets.

      • idrequired — (String)

        The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

      • successful — (Array<map>)

        The targets that were successfully registered.

        • idrequired — (String)

          The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

        • port — (Integer)

          The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

      • unsuccessful — (Array<map>)

        The targets that were not registered.

        • failureCode — (String)

          The failure code.

        • failureMessage — (String)

          The failure message.

        • id — (String)

          The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

        • port — (Integer)

          The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function.

Returns:

  • (AWS.Request)

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

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

Adds the specified tags to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.tagResource(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags for the resource.

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.

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

Removes the specified tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
vpclattice.untagResource(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The tag keys of the tags to remove.

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.

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

Updates the specified access log subscription.

Service Reference:

Examples:

Calling the updateAccessLogSubscription operation

var params = {
  accessLogSubscriptionIdentifier: 'STRING_VALUE', /* required */
  destinationArn: 'STRING_VALUE' /* required */
};
vpclattice.updateAccessLogSubscription(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: {})
    • accessLogSubscriptionIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the access log subscription.

    • destinationArn — (String)

      The Amazon Resource Name (ARN) of the access log destination.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the access log subscription.

      • destinationArn — (String)

        The Amazon Resource Name (ARN) of the access log destination.

      • id — (String)

        The ID of the access log subscription.

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the access log subscription.

      • resourceId — (String)

        The ID of the resource.

Returns:

  • (AWS.Request)

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

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

Updates the specified listener for the specified service.

Service Reference:

Examples:

Calling the updateListener operation

var params = {
  defaultAction: { /* required */
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.updateListener(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: {})
    • defaultAction — (map)

      The action for the default rule.

      • fixedResponse — (map)

        The fixed response action. The rule returns a custom HTTP response.

        • statusCoderequired — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroupsrequired — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

          • targetGroupIdentifierrequired — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • defaultAction — (map)

        The action for the default rule.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • id — (String)

        The ID of the listener.

      • name — (String)

        The name of the listener.

      • port — (Integer)

        The listener port.

      • protocol — (String)

        The protocol of the listener.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TLS_PASSTHROUGH"
      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service.

      • serviceId — (String)

        The ID of the service.

Returns:

  • (AWS.Request)

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

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

Updates a rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.

Service Reference:

Examples:

Calling the updateRule operation

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  ruleIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  action: {
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  match: {
    httpMatch: {
      headerMatches: [
        {
          match: { /* required */
            contains: 'STRING_VALUE',
            exact: 'STRING_VALUE',
            prefix: 'STRING_VALUE'
          },
          name: 'STRING_VALUE', /* required */
          caseSensitive: true || false
        },
        /* more items */
      ],
      method: 'STRING_VALUE',
      pathMatch: {
        match: { /* required */
          exact: 'STRING_VALUE',
          prefix: 'STRING_VALUE'
        },
        caseSensitive: true || false
      }
    }
  },
  priority: 'NUMBER_VALUE'
};
vpclattice.updateRule(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: {})
    • action — (map)

      Information about the action for the specified listener rule.

      • fixedResponse — (map)

        The fixed response action. The rule returns a custom HTTP response.

        • statusCoderequired — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroupsrequired — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

          • targetGroupIdentifierrequired — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • listenerIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the listener.

    • match — (map)

      The rule match.

      • httpMatch — (map)

        The HTTP criteria that a rule must match.

        • headerMatches — (Array<map>)

          The header matches. Matches incoming requests with rule based on request header value before applying rule action.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive.

          • matchrequired — (map)

            The header match type.

            • contains — (String)

              A contains type match.

            • exact — (String)

              An exact type match.

            • prefix — (String)

              A prefix type match. Matches the value with the prefix.

          • namerequired — (String)

            The name of the header.

        • method — (String)

          The HTTP method type.

        • pathMatch — (map)

          The path match.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive.

          • matchrequired — (map)

            The type of path match.

            • exact — (String)

              An exact match of the path.

            • prefix — (String)

              A prefix match of the path.

    • priority — (Integer)

      The rule priority. A listener can't have multiple rules with the same priority.

    • ruleIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the rule.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • action — (map)

        Information about the action for the specified listener rule.

        • fixedResponse — (map)

          The fixed response action. The rule returns a custom HTTP response.

          • statusCoderequired — (Integer)

            The HTTP response code.

        • forward — (map)

          The forward action. Traffic that matches the rule is forwarded to the specified target groups.

          • targetGroupsrequired — (Array<map>)

            The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

            The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

            • targetGroupIdentifierrequired — (String)

              The ID or Amazon Resource Name (ARN) of the target group.

            • weight — (Integer)

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • id — (String)

        The ID of the listener.

      • isDefault — (Boolean)

        Indicates whether this is the default rule.

      • match — (map)

        The rule match.

        • httpMatch — (map)

          The HTTP criteria that a rule must match.

          • headerMatches — (Array<map>)

            The header matches. Matches incoming requests with rule based on request header value before applying rule action.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The header match type.

              • contains — (String)

                A contains type match.

              • exact — (String)

                An exact type match.

              • prefix — (String)

                A prefix type match. Matches the value with the prefix.

            • namerequired — (String)

              The name of the header.

          • method — (String)

            The HTTP method type.

          • pathMatch — (map)

            The path match.

            • caseSensitive — (Boolean)

              Indicates whether the match is case sensitive.

            • matchrequired — (map)

              The type of path match.

              • exact — (String)

                An exact match of the path.

              • prefix — (String)

                A prefix match of the path.

      • name — (String)

        The name of the listener.

      • priority — (Integer)

        The rule priority.

Returns:

  • (AWS.Request)

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

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

Updates the specified service.

Service Reference:

Examples:

Calling the updateService operation

var params = {
  serviceIdentifier: 'STRING_VALUE', /* required */
  authType: NONE | AWS_IAM,
  certificateArn: 'STRING_VALUE'
};
vpclattice.updateService(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: {})
    • authType — (String)

      The type of IAM policy.

      • NONE: The resource does not use an IAM policy. This is the default.

      • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • certificateArn — (String)

      The Amazon Resource Name (ARN) of the certificate.

    • serviceIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate.

      • customDomainName — (String)

        The custom domain name of the service.

      • id — (String)

        The ID of the service.

      • name — (String)

        The name of the service.

Returns:

  • (AWS.Request)

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

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

Updates the specified service network.

Service Reference:

Examples:

Calling the updateServiceNetwork operation

var params = {
  authType: NONE | AWS_IAM, /* required */
  serviceNetworkIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.updateServiceNetwork(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: {})
    • authType — (String)

      The type of IAM policy.

      • NONE: The resource does not use an IAM policy. This is the default.

      • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • serviceNetworkIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the service network.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • authType — (String)

        The type of IAM policy.

        Possible values include:
        • "NONE"
        • "AWS_IAM"
      • id — (String)

        The ID of the service network.

      • name — (String)

        The name of the service network.

Returns:

  • (AWS.Request)

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

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

Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Examples:

Calling the updateServiceNetworkVpcAssociation operation

var params = {
  securityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  serviceNetworkVpcAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.updateServiceNetworkVpcAssociation(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: {})
    • securityGroupIds — (Array<String>)

      The IDs of the security groups.

    • serviceNetworkVpcAssociationIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the association.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdBy — (String)

        The account that created the association.

      • id — (String)

        The ID of the association.

      • securityGroupIds — (Array<String>)

        The IDs of the security groups.

      • status — (String)

        The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change in the status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Updates the specified target group.

Service Reference:

Examples:

Calling the updateTargetGroup operation

var params = {
  healthCheck: { /* required */
    enabled: true || false,
    healthCheckIntervalSeconds: 'NUMBER_VALUE',
    healthCheckTimeoutSeconds: 'NUMBER_VALUE',
    healthyThresholdCount: 'NUMBER_VALUE',
    matcher: {
      httpCode: 'STRING_VALUE'
    },
    path: 'STRING_VALUE',
    port: 'NUMBER_VALUE',
    protocol: HTTP | HTTPS | TCP,
    protocolVersion: HTTP1 | HTTP2,
    unhealthyThresholdCount: 'NUMBER_VALUE'
  },
  targetGroupIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.updateTargetGroup(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: {})
    • healthCheck — (map)

      The health check configuration.

      • enabled — (Boolean)

        Indicates whether health checking is enabled.

      • healthCheckIntervalSeconds — (Integer)

        The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

      • healthCheckTimeoutSeconds — (Integer)

        The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

      • healthyThresholdCount — (Integer)

        The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

      • matcher — (map)

        The codes to use when checking for a successful response from a target.

        • httpCode — (String)

          The HTTP code to use when checking for a successful response from a target.

      • path — (String)

        The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

      • port — (Integer)

        The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

      • protocol — (String)

        The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
      • protocolVersion — (String)

        The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

        Possible values include:
        • "HTTP1"
        • "HTTP2"
      • unhealthyThresholdCount — (Integer)

        The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

    • targetGroupIdentifier — (String)

      The ID or Amazon Resource Name (ARN) of the target 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. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Name (ARN) of the target group.

      • config — (map)

        The target group configuration.

        • healthCheck — (map)

          The health check configuration. Not supported if the target group type is LAMBDA or ALB.

          • enabled — (Boolean)

            Indicates whether health checking is enabled.

          • healthCheckIntervalSeconds — (Integer)

            The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

          • healthCheckTimeoutSeconds — (Integer)

            The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

          • healthyThresholdCount — (Integer)

            The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

          • matcher — (map)

            The codes to use when checking for a successful response from a target.

            • httpCode — (String)

              The HTTP code to use when checking for a successful response from a target.

          • path — (String)

            The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

          • port — (Integer)

            The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

          • protocol — (String)

            The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • protocolVersion — (String)

            The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

            Possible values include:
            • "HTTP1"
            • "HTTP2"
          • unhealthyThresholdCount — (Integer)

            The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

        • ipAddressType — (String)

          The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • lambdaEventStructureVersion — (String)

          The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

          Possible values include:
          • "V1"
          • "V2"
        • port — (Integer)

          The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

        • protocol — (String)

          The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • protocolVersion — (String)

          The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
          • "GRPC"
        • vpcIdentifier — (String)

          The ID of the VPC. Not supported if the target group type is LAMBDA.

      • id — (String)

        The ID of the target group.

      • name — (String)

        The name of the target group.

      • status — (String)

        The status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
      • type — (String)

        The target group type.

        Possible values include:
        • "IP"
        • "LAMBDA"
        • "INSTANCE"
        • "ALB"

Returns:

  • (AWS.Request)

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