You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Imagebuilder

Inherits:
AWS.Service show all
Identifier:
imagebuilder
API Version:
2019-12-02
Defined in:
(unknown)

Overview

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

Service Description

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Sending a Request Using Imagebuilder

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

var imagebuilder = new AWS.Imagebuilder({apiVersion: '2019-12-02'});

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

AWS.config.apiVersions = {
  imagebuilder: '2019-12-02',
  // other service API versions
};

var imagebuilder = new AWS.Imagebuilder();

Version:

  • 2019-12-02

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.Imagebuilder(options = {}) ⇒ Object

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

Examples:

Constructing a Imagebuilder object

var imagebuilder = new AWS.Imagebuilder({apiVersion: '2019-12-02'});

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Imagebuilder.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'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

Service Reference:

Examples:

Calling the cancelImageCreation operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imageBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.cancelImageCreation(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: {}) —
    • imageBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

Returns:

  • (AWS.Request) —

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

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

Creates a new component that can be used to build, validate, test, and assess your image.

Service Reference:

Examples:

Calling the createComponent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  platform: Windows | Linux, /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  changeDescription: 'STRING_VALUE',
  data: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  supportedOsVersions: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  uri: 'STRING_VALUE'
};
imagebuilder.createComponent(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: {}) —
    • name — (String)

      The name of the component.

    • semanticVersion — (String)

      The semantic version of the component. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • description — (String)

      The description of the component. Describes the contents of the component.

    • changeDescription — (String)

      The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

    • platform — (String)

      The platform of the component.

      Possible values include:
      • "Windows"
      • "Linux"
    • supportedOsVersions — (Array<String>)

      The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

    • data — (String)

      The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

    • uri — (String)

      The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

    • kmsKeyId — (String)

      The ID of the KMS key that should be used to encrypt this component.

    • tags — (map<String>)

      The tags of the component.

    • clientToken — (String)

      The idempotency token of the component.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • componentBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the component that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Service Reference:

Examples:

Calling the createContainerRecipe operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  components: [ /* required */
    {
      componentArn: 'STRING_VALUE', /* required */
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  containerType: DOCKER, /* required */
  name: 'STRING_VALUE', /* required */
  parentImage: 'STRING_VALUE', /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  targetRepository: { /* required */
    repositoryName: 'STRING_VALUE', /* required */
    service: ECR /* required */
  },
  description: 'STRING_VALUE',
  dockerfileTemplateData: 'STRING_VALUE',
  dockerfileTemplateUri: 'STRING_VALUE',
  imageOsVersionOverride: 'STRING_VALUE',
  instanceConfiguration: {
    blockDeviceMappings: [
      {
        deviceName: 'STRING_VALUE',
        ebs: {
          deleteOnTermination: true || false,
          encrypted: true || false,
          iops: 'NUMBER_VALUE',
          kmsKeyId: 'STRING_VALUE',
          snapshotId: 'STRING_VALUE',
          throughput: 'NUMBER_VALUE',
          volumeSize: 'NUMBER_VALUE',
          volumeType: standard | io1 | io2 | gp2 | gp3 | sc1 | st1
        },
        noDevice: 'STRING_VALUE',
        virtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    image: 'STRING_VALUE'
  },
  kmsKeyId: 'STRING_VALUE',
  platformOverride: Windows | Linux,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workingDirectory: 'STRING_VALUE'
};
imagebuilder.createContainerRecipe(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: {}) —
    • containerType — (String)

      The type of container to create.

      Possible values include:
      • "DOCKER"
    • name — (String)

      The name of the container recipe.

    • description — (String)

      The description of the container recipe.

    • semanticVersion — (String)

      The semantic version of the container recipe. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • components — (Array<map>)

      Components for build and test that are included in the container recipe.

      • componentArn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • parameters — (Array<map>)

        A group of parameter settings that are used to configure the component for a specific recipe.

        • name — required — (String)

          The name of the component parameter to set.

        • value — required — (Array<String>)

          Sets the value for the named component parameter.

    • instanceConfiguration — (map)

      A group of options that can be used to configure an instance for building and testing container images.

      • image — (String)

        The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

      • blockDeviceMappings — (Array<map>)

        Defines the block devices to attach for building an instance from this Image Builder AMI.

        • deviceName — (String)

          The device to which these mappings apply.

        • ebs — (map)

          Use to manage Amazon EBS-specific configuration for this mapping.

          • encrypted — (Boolean)

            Use to configure device encryption.

          • deleteOnTermination — (Boolean)

            Use to configure delete on termination of the associated device.

          • iops — (Integer)

            Use to configure device IOPS.

          • kmsKeyId — (String)

            Use to configure the KMS key to use when encrypting the device.

          • snapshotId — (String)

            The snapshot that defines the device contents.

          • volumeSize — (Integer)

            Use to override the device's volume size.

          • volumeType — (String)

            Use to override the device's volume type.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "gp3"
            • "sc1"
            • "st1"
          • throughput — (Integer)

            For GP3 volumes only – The throughput in MiB/s that the volume supports.

        • virtualName — (String)

          Use to manage instance ephemeral devices.

        • noDevice — (String)

          Use to remove a mapping from the base image.

    • dockerfileTemplateData — (String)

      The Dockerfile template used to build your image as an inline data blob.

    • dockerfileTemplateUri — (String)

      The Amazon S3 URI for the Dockerfile that will be used to build your container image.

    • platformOverride — (String)

      Specifies the operating system platform when you use a custom base image.

      Possible values include:
      • "Windows"
      • "Linux"
    • imageOsVersionOverride — (String)

      Specifies the operating system version for the base image.

    • parentImage — (String)

      The base image for the container recipe.

    • tags — (map<String>)

      Tags that are attached to the container recipe.

    • workingDirectory — (String)

      The working directory for use during build and test workflows.

    • targetRepository — (map)

      The destination repository for the container image.

      • service — required — (String)

        Specifies the service in which this image was registered.

        Possible values include:
        • "ECR"
      • repositoryName — required — (String)

        The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

    • kmsKeyId — (String)

      Identifies which KMS key is used to encrypt the container image.

    • clientToken — (String)

      The client token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token used to make this request idempotent.

      • containerRecipeArn — (String)

        Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

Returns:

  • (AWS.Request) —

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

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

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Service Reference:

Examples:

Calling the createDistributionConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  distributions: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      amiDistributionConfiguration: {
        amiTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        description: 'STRING_VALUE',
        kmsKeyId: 'STRING_VALUE',
        launchPermission: {
          userGroups: [
            'STRING_VALUE',
            /* more items */
          ],
          userIds: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        name: 'STRING_VALUE',
        targetAccountIds: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      containerDistributionConfiguration: {
        targetRepository: { /* required */
          repositoryName: 'STRING_VALUE', /* required */
          service: ECR /* required */
        },
        containerTags: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE'
      },
      launchTemplateConfigurations: [
        {
          launchTemplateId: 'STRING_VALUE', /* required */
          accountId: 'STRING_VALUE',
          setDefaultVersion: true || false
        },
        /* more items */
      ],
      licenseConfigurationArns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.createDistributionConfiguration(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: {}) —
    • name — (String)

      The name of the distribution configuration.

    • description — (String)

      The description of the distribution configuration.

    • distributions — (Array<map>)

      The distributions of the distribution configuration.

      • region — required — (String)

        The target Region.

      • amiDistributionConfiguration — (map)

        The specific AMI settings; for example, launch permissions or AMI tags.

        • name — (String)

          The name of the output AMI.

        • description — (String)

          The description of the distribution configuration. Minimum and maximum length are in characters.

        • targetAccountIds — (Array<String>)

          The ID of an account to which you want to distribute an image.

        • amiTags — (map<String>)

          The tags to apply to AMIs distributed to this Region.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the distributed image.

        • launchPermission — (map)

          Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

          • userIds — (Array<String>)

            The Amazon Web Services account ID.

          • userGroups — (Array<String>)

            The name of the group.

      • containerDistributionConfiguration — (map)

        Container distribution settings for encryption, licensing, and sharing in a specific Region.

        • description — (String)

          The description of the container distribution configuration.

        • containerTags — (Array<String>)

          Tags that are attached to the container distribution configuration.

        • targetRepository — required — (map)

          The destination repository for the container distribution configuration.

          • service — required — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryName — required — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

      • licenseConfigurationArns — (Array<String>)

        The License Manager Configuration to associate with the AMI in the specified Region.

      • launchTemplateConfigurations — (Array<map>)

        A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

        • launchTemplateId — required — (String)

          Identifies the Amazon EC2 launch template to use.

        • accountId — (String)

          The account ID that this configuration applies to.

        • setDefaultVersion — (Boolean)

          Set the specified Amazon EC2 launch template as the default launch template for the specified account.

    • tags — (map<String>)

      The tags of the distribution configuration.

    • clientToken — (String)

      The idempotency token of the distribution configuration.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Service Reference:

Examples:

Calling the createImage operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  imageRecipeArn: 'STRING_VALUE',
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.createImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

    • imageTestsConfiguration — (map)

      The image tests configuration of the image.

      • imageTestsEnabled — (Boolean)

        Defines if tests should be executed when building this image.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • tags — (map<String>)

      The tags of the image.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Service Reference:

Examples:

Calling the createImagePipeline operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  imageRecipeArn: 'STRING_VALUE',
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  schedule: {
    pipelineExecutionStartCondition: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
    scheduleExpression: 'STRING_VALUE',
    timezone: 'STRING_VALUE'
  },
  status: DISABLED | ENABLED,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.createImagePipeline(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: {}) —
    • name — (String)

      The name of the image pipeline.

    • description — (String)

      The description of the image pipeline.

    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

    • imageTestsConfiguration — (map)

      The image test configuration of the image pipeline.

      • imageTestsEnabled — (Boolean)

        Defines if tests should be executed when building this image.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • schedule — (map)

      The schedule of the image pipeline.

      • scheduleExpression — (String)

        The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

        For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

      • timezone — (String)

        The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

      • pipelineExecutionStartCondition — (String)

        The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

        Possible values include:
        • "EXPRESSION_MATCH_ONLY"
        • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    • status — (String)

      The status of the image pipeline.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • tags — (map<String>)

      The tags of the image pipeline.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Service Reference:

Examples:

Calling the createImageRecipe operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  components: [ /* required */
    {
      componentArn: 'STRING_VALUE', /* required */
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  parentImage: 'STRING_VALUE', /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  additionalInstanceConfiguration: {
    systemsManagerAgent: {
      uninstallAfterBuild: true || false
    },
    userDataOverride: 'STRING_VALUE'
  },
  blockDeviceMappings: [
    {
      deviceName: 'STRING_VALUE',
      ebs: {
        deleteOnTermination: true || false,
        encrypted: true || false,
        iops: 'NUMBER_VALUE',
        kmsKeyId: 'STRING_VALUE',
        snapshotId: 'STRING_VALUE',
        throughput: 'NUMBER_VALUE',
        volumeSize: 'NUMBER_VALUE',
        volumeType: standard | io1 | io2 | gp2 | gp3 | sc1 | st1
      },
      noDevice: 'STRING_VALUE',
      virtualName: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workingDirectory: 'STRING_VALUE'
};
imagebuilder.createImageRecipe(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: {}) —
    • name — (String)

      The name of the image recipe.

    • description — (String)

      The description of the image recipe.

    • semanticVersion — (String)

      The semantic version of the image recipe. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • components — (Array<map>)

      The components of the image recipe.

      • componentArn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • parameters — (Array<map>)

        A group of parameter settings that are used to configure the component for a specific recipe.

        • name — required — (String)

          The name of the component parameter to set.

        • value — required — (Array<String>)

          Sets the value for the named component parameter.

    • parentImage — (String)

      The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

    • blockDeviceMappings — (Array<map>)

      The block device mappings of the image recipe.

      • deviceName — (String)

        The device to which these mappings apply.

      • ebs — (map)

        Use to manage Amazon EBS-specific configuration for this mapping.

        • encrypted — (Boolean)

          Use to configure device encryption.

        • deleteOnTermination — (Boolean)

          Use to configure delete on termination of the associated device.

        • iops — (Integer)

          Use to configure device IOPS.

        • kmsKeyId — (String)

          Use to configure the KMS key to use when encrypting the device.

        • snapshotId — (String)

          The snapshot that defines the device contents.

        • volumeSize — (Integer)

          Use to override the device's volume size.

        • volumeType — (String)

          Use to override the device's volume type.

          Possible values include:
          • "standard"
          • "io1"
          • "io2"
          • "gp2"
          • "gp3"
          • "sc1"
          • "st1"
        • throughput — (Integer)

          For GP3 volumes only – The throughput in MiB/s that the volume supports.

      • virtualName — (String)

        Use to manage instance ephemeral devices.

      • noDevice — (String)

        Use to remove a mapping from the base image.

    • tags — (map<String>)

      The tags of the image recipe.

    • workingDirectory — (String)

      The working directory used during build and test workflows.

    • additionalInstanceConfiguration — (map)

      Specify additional settings and launch scripts for your build instances.

      • systemsManagerAgent — (map)

        Contains settings for the Systems Manager agent on your build instance.

        • uninstallAfterBuild — (Boolean)

          Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

      • userDataOverride — (String)

        Use this property to provide commands or a command script to run when you launch your build instance.

        Note: The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Service Reference:

Examples:

Calling the createInfrastructureConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  instanceProfileName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  instanceMetadataOptions: {
    httpPutResponseHopLimit: 'NUMBER_VALUE',
    httpTokens: 'STRING_VALUE'
  },
  instanceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  keyPair: 'STRING_VALUE',
  logging: {
    s3Logs: {
      s3BucketName: 'STRING_VALUE',
      s3KeyPrefix: 'STRING_VALUE'
    }
  },
  resourceTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  snsTopicArn: 'STRING_VALUE',
  subnetId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  terminateInstanceOnFailure: true || false
};
imagebuilder.createInfrastructureConfiguration(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: {}) —
    • name — (String)

      The name of the infrastructure configuration.

    • description — (String)

      The description of the infrastructure configuration.

    • instanceTypes — (Array<String>)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

    • instanceProfileName — (String)

      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • securityGroupIds — (Array<String>)

      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • subnetId — (String)

      The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

    • logging — (map)

      The logging configuration of the infrastructure configuration.

      • s3Logs — (map)

        The Amazon S3 logging configuration.

        • s3BucketName — (String)

          The Amazon S3 bucket in which to store the logs.

        • s3KeyPrefix — (String)

          The Amazon S3 path in which to store the logs.

    • keyPair — (String)

      The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

    • terminateInstanceOnFailure — (Boolean)

      The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

    • snsTopicArn — (String)

      The SNS topic on which to send image build events.

    • resourceTags — (map<String>)

      The tags attached to the resource created by Image Builder.

    • instanceMetadataOptions — (map)

      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

      • httpTokens — (String)

        Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

        • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

        • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

        The default setting is optional.

      • httpPutResponseHopLimit — (Integer)

        Limit the number of hops that an instance metadata request can traverse to reach its destination.

    • tags — (map<String>)

      The tags of the infrastructure configuration.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Deletes a component build version.

Service Reference:

Examples:

Calling the deleteComponent operation

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

      The Amazon Resource Name (ARN) of the component build version to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the component build version that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes a container recipe.

Service Reference:

Examples:

Calling the deleteContainerRecipe operation

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

      The Amazon Resource Name (ARN) of the container recipe to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeArn — (String)

        The Amazon Resource Name (ARN) of the container recipe that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes a distribution configuration.

Service Reference:

Examples:

Calling the deleteDistributionConfiguration operation

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

      The Amazon Resource Name (ARN) of the distribution configuration to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.

Service Reference:

Examples:

Calling the deleteImage operation

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

      The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the Image Builder image resource that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes an image pipeline.

Service Reference:

Examples:

Calling the deleteImagePipeline operation

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

      The Amazon Resource Name (ARN) of the image pipeline to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes an image recipe.

Service Reference:

Examples:

Calling the deleteImageRecipe operation

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

      The Amazon Resource Name (ARN) of the image recipe to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes an infrastructure configuration.

Service Reference:

Examples:

Calling the deleteInfrastructureConfiguration operation

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

      The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

Returns:

  • (AWS.Request) —

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

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

Gets a component object.

Service Reference:

Examples:

Calling the getComponent operation

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

      The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+$" suffix.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • component — (map)

        The component object associated with the specified ARN.

        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

        • name — (String)

          The name of the component.

        • version — (String)

          The version of the component.

        • description — (String)

          The description of the component.

        • changeDescription — (String)

          The change description of the component.

        • type — (String)

          The type of the component denotes whether the component is used to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • platform — (String)

          The platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        • state — (map)

          Describes the current status of the component. This is used for components that are no longer active.

          • status — (String)

            The current state of the component.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the component changed state.

        • parameters — (Array<map>)

          Contains parameter details for each of the parameters that are defined for the component.

          • name — required — (String)

            The name of this input parameter.

          • type — required — (String)

            The type of input this parameter provides. The currently supported value is "string".

          • defaultValue — (Array<String>)

            The default value of this parameter if no input is provided.

          • description — (String)

            Describes this parameter.

        • owner — (String)

          The owner of the component.

        • data — (String)

          The data of the component.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the component.

        • encrypted — (Boolean)

          The encryption status of the component.

        • dateCreated — (String)

          The date that the component was created.

        • tags — (map<String>)

          The tags associated with the component.

Returns:

  • (AWS.Request) —

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

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

Gets a component policy.

Service Reference:

Examples:

Calling the getComponentPolicy operation

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

      The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The component policy.

Returns:

  • (AWS.Request) —

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

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

Retrieves a container recipe.

Service Reference:

Examples:

Calling the getContainerRecipe operation

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

      The Amazon Resource Name (ARN) of the container recipe to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipe — (map)

        The container recipe object that is returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the container recipe.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • containerType — (String)

          Specifies the type of container, such as Docker.

          Possible values include:
          • "DOCKER"
        • name — (String)

          The name of the container recipe.

        • description — (String)

          The description of the container recipe.

        • platform — (String)

          The system platform for the container, such as Windows or Linux.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the container recipe.

        • version — (String)

          The semantic version of the container recipe.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • components — (Array<map>)

          Components for build and test that are included in the container recipe.

          • componentArn — required — (String)

            The Amazon Resource Name (ARN) of the component.

          • parameters — (Array<map>)

            A group of parameter settings that are used to configure the component for a specific recipe.

            • name — required — (String)

              The name of the component parameter to set.

            • value — required — (Array<String>)

              Sets the value for the named component parameter.

        • instanceConfiguration — (map)

          A group of options that can be used to configure an instance for building and testing container images.

          • image — (String)

            The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

          • blockDeviceMappings — (Array<map>)

            Defines the block devices to attach for building an instance from this Image Builder AMI.

            • deviceName — (String)

              The device to which these mappings apply.

            • ebs — (map)

              Use to manage Amazon EBS-specific configuration for this mapping.

              • encrypted — (Boolean)

                Use to configure device encryption.

              • deleteOnTermination — (Boolean)

                Use to configure delete on termination of the associated device.

              • iops — (Integer)

                Use to configure device IOPS.

              • kmsKeyId — (String)

                Use to configure the KMS key to use when encrypting the device.

              • snapshotId — (String)

                The snapshot that defines the device contents.

              • volumeSize — (Integer)

                Use to override the device's volume size.

              • volumeType — (String)

                Use to override the device's volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "gp3"
                • "sc1"
                • "st1"
              • throughput — (Integer)

                For GP3 volumes only – The throughput in MiB/s that the volume supports.

            • virtualName — (String)

              Use to manage instance ephemeral devices.

            • noDevice — (String)

              Use to remove a mapping from the base image.

        • dockerfileTemplateData — (String)

          Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

        • kmsKeyId — (String)

          Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

        • encrypted — (Boolean)

          A flag that indicates if the target container is encrypted.

        • parentImage — (String)

          The base image for the container recipe.

        • dateCreated — (String)

          The date when this container recipe was created.

        • tags — (map<String>)

          Tags that are attached to the container recipe.

        • workingDirectory — (String)

          The working directory for use during build and test workflows.

        • targetRepository — (map)

          The destination repository for the container image.

          • service — required — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryName — required — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

Returns:

  • (AWS.Request) —

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

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

Retrieves the policy for a container recipe.

Service Reference:

Examples:

Calling the getContainerRecipePolicy operation

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

      The Amazon Resource Name (ARN) of the container recipe for the policy being requested.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The container recipe policy object that is returned.

Returns:

  • (AWS.Request) —

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

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

Gets a distribution configuration.

Service Reference:

Examples:

Calling the getDistributionConfiguration operation

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

      The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfiguration — (map)

        The distribution configuration object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration.

        • name — (String)

          The name of the distribution configuration.

        • description — (String)

          The description of the distribution configuration.

        • distributions — (Array<map>)

          The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.

          • region — required — (String)

            The target Region.

          • amiDistributionConfiguration — (map)

            The specific AMI settings; for example, launch permissions or AMI tags.

            • name — (String)

              The name of the output AMI.

            • description — (String)

              The description of the distribution configuration. Minimum and maximum length are in characters.

            • targetAccountIds — (Array<String>)

              The ID of an account to which you want to distribute an image.

            • amiTags — (map<String>)

              The tags to apply to AMIs distributed to this Region.

            • kmsKeyId — (String)

              The KMS key identifier used to encrypt the distributed image.

            • launchPermission — (map)

              Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

              • userIds — (Array<String>)

                The Amazon Web Services account ID.

              • userGroups — (Array<String>)

                The name of the group.

          • containerDistributionConfiguration — (map)

            Container distribution settings for encryption, licensing, and sharing in a specific Region.

            • description — (String)

              The description of the container distribution configuration.

            • containerTags — (Array<String>)

              Tags that are attached to the container distribution configuration.

            • targetRepository — required — (map)

              The destination repository for the container distribution configuration.

              • service — required — (String)

                Specifies the service in which this image was registered.

                Possible values include:
                • "ECR"
              • repositoryName — required — (String)

                The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

          • licenseConfigurationArns — (Array<String>)

            The License Manager Configuration to associate with the AMI in the specified Region.

          • launchTemplateConfigurations — (Array<map>)

            A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

            • launchTemplateId — required — (String)

              Identifies the Amazon EC2 launch template to use.

            • accountId — (String)

              The account ID that this configuration applies to.

            • setDefaultVersion — (Boolean)

              Set the specified Amazon EC2 launch template as the default launch template for the specified account.

        • timeoutMinutes — required — (Integer)

          The maximum duration in minutes for this distribution configuration.

        • dateCreated — (String)

          The date on which this distribution configuration was created.

        • dateUpdated — (String)

          The date on which this distribution configuration was last updated.

        • tags — (map<String>)

          The tags of the distribution configuration.

Returns:

  • (AWS.Request) —

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

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

Gets an image.

Service Reference:

Examples:

Calling the getImage operation

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

      The Amazon Resource Name (ARN) of the image that you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • image — (map)

        The image object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • type — (String)

          Specifies whether this is an AMI or container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • name — (String)

          The name of the image.

        • version — (String)

          The semantic version of the image.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • platform — (String)

          The platform of the image.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

        • osVersion — (String)

          The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
          • reason — (String)

            The reason for the image's status.

        • imageRecipe — (map)

          The image recipe used when creating the image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the image recipe.

          • type — (String)

            Specifies which type of image is created by the recipe - an AMI or a container image.

            Possible values include:
            • "AMI"
            • "DOCKER"
          • name — (String)

            The name of the image recipe.

          • description — (String)

            The description of the image recipe.

          • platform — (String)

            The platform of the image recipe.

            Possible values include:
            • "Windows"
            • "Linux"
          • owner — (String)

            The owner of the image recipe.

          • version — (String)

            The version of the image recipe.

          • components — (Array<map>)

            The components of the image recipe.

            • componentArn — required — (String)

              The Amazon Resource Name (ARN) of the component.

            • parameters — (Array<map>)

              A group of parameter settings that are used to configure the component for a specific recipe.

              • name — required — (String)

                The name of the component parameter to set.

              • value — required — (Array<String>)

                Sets the value for the named component parameter.

          • parentImage — (String)

            The base image of the image recipe.

          • blockDeviceMappings — (Array<map>)

            The block device mappings to apply when creating images from this recipe.

            • deviceName — (String)

              The device to which these mappings apply.

            • ebs — (map)

              Use to manage Amazon EBS-specific configuration for this mapping.

              • encrypted — (Boolean)

                Use to configure device encryption.

              • deleteOnTermination — (Boolean)

                Use to configure delete on termination of the associated device.

              • iops — (Integer)

                Use to configure device IOPS.

              • kmsKeyId — (String)

                Use to configure the KMS key to use when encrypting the device.

              • snapshotId — (String)

                The snapshot that defines the device contents.

              • volumeSize — (Integer)

                Use to override the device's volume size.

              • volumeType — (String)

                Use to override the device's volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "gp3"
                • "sc1"
                • "st1"
              • throughput — (Integer)

                For GP3 volumes only – The throughput in MiB/s that the volume supports.

            • virtualName — (String)

              Use to manage instance ephemeral devices.

            • noDevice — (String)

              Use to remove a mapping from the base image.

          • dateCreated — (String)

            The date on which this image recipe was created.

          • tags — (map<String>)

            The tags of the image recipe.

          • workingDirectory — (String)

            The working directory to be used during build and test workflows.

          • additionalInstanceConfiguration — (map)

            Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

            • systemsManagerAgent — (map)

              Contains settings for the Systems Manager agent on your build instance.

              • uninstallAfterBuild — (Boolean)

                Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

            • userDataOverride — (String)

              Use this property to provide commands or a command script to run when you launch your build instance.

              Note: The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
        • containerRecipe — (map)

          The recipe that is used to create an Image Builder container image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the container recipe.

            Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
            1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
            2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
            3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
          • containerType — (String)

            Specifies the type of container, such as Docker.

            Possible values include:
            • "DOCKER"
          • name — (String)

            The name of the container recipe.

          • description — (String)

            The description of the container recipe.

          • platform — (String)

            The system platform for the container, such as Windows or Linux.

            Possible values include:
            • "Windows"
            • "Linux"
          • owner — (String)

            The owner of the container recipe.

          • version — (String)

            The semantic version of the container recipe.

            Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
          • components — (Array<map>)

            Components for build and test that are included in the container recipe.

            • componentArn — required — (String)

              The Amazon Resource Name (ARN) of the component.

            • parameters — (Array<map>)

              A group of parameter settings that are used to configure the component for a specific recipe.

              • name — required — (String)

                The name of the component parameter to set.

              • value — required — (Array<String>)

                Sets the value for the named component parameter.

          • instanceConfiguration — (map)

            A group of options that can be used to configure an instance for building and testing container images.

            • image — (String)

              The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

            • blockDeviceMappings — (Array<map>)

              Defines the block devices to attach for building an instance from this Image Builder AMI.

              • deviceName — (String)

                The device to which these mappings apply.

              • ebs — (map)

                Use to manage Amazon EBS-specific configuration for this mapping.

                • encrypted — (Boolean)

                  Use to configure device encryption.

                • deleteOnTermination — (Boolean)

                  Use to configure delete on termination of the associated device.

                • iops — (Integer)

                  Use to configure device IOPS.

                • kmsKeyId — (String)

                  Use to configure the KMS key to use when encrypting the device.

                • snapshotId — (String)

                  The snapshot that defines the device contents.

                • volumeSize — (Integer)

                  Use to override the device's volume size.

                • volumeType — (String)

                  Use to override the device's volume type.

                  Possible values include:
                  • "standard"
                  • "io1"
                  • "io2"
                  • "gp2"
                  • "gp3"
                  • "sc1"
                  • "st1"
                • throughput — (Integer)

                  For GP3 volumes only – The throughput in MiB/s that the volume supports.

              • virtualName — (String)

                Use to manage instance ephemeral devices.

              • noDevice — (String)

                Use to remove a mapping from the base image.

          • dockerfileTemplateData — (String)

            Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

          • kmsKeyId — (String)

            Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

          • encrypted — (Boolean)

            A flag that indicates if the target container is encrypted.

          • parentImage — (String)

            The base image for the container recipe.

          • dateCreated — (String)

            The date when this container recipe was created.

          • tags — (map<String>)

            Tags that are attached to the container recipe.

          • workingDirectory — (String)

            The working directory for use during build and test workflows.

          • targetRepository — (map)

            The destination repository for the container image.

            • service — required — (String)

              Specifies the service in which this image was registered.

              Possible values include:
              • "ECR"
            • repositoryName — required — (String)

              The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

        • sourcePipelineName — (String)

          The name of the image pipeline that created this image.

        • sourcePipelineArn — (String)

          The Amazon Resource Name (ARN) of the image pipeline that created this image.

        • infrastructureConfiguration — (map)

          The infrastructure used when creating this image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the infrastructure configuration.

          • name — (String)

            The name of the infrastructure configuration.

          • description — (String)

            The description of the infrastructure configuration.

          • instanceTypes — (Array<String>)

            The instance types of the infrastructure configuration.

          • instanceProfileName — (String)

            The instance profile of the infrastructure configuration.

          • securityGroupIds — (Array<String>)

            The security group IDs of the infrastructure configuration.

          • subnetId — (String)

            The subnet ID of the infrastructure configuration.

          • logging — (map)

            The logging configuration of the infrastructure configuration.

            • s3Logs — (map)

              The Amazon S3 logging configuration.

              • s3BucketName — (String)

                The Amazon S3 bucket in which to store the logs.

              • s3KeyPrefix — (String)

                The Amazon S3 path in which to store the logs.

          • keyPair — (String)

            The Amazon EC2 key pair of the infrastructure configuration.

          • terminateInstanceOnFailure — (Boolean)

            The terminate instance on failure configuration of the infrastructure configuration.

          • snsTopicArn — (String)

            The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

          • dateCreated — (String)

            The date on which the infrastructure configuration was created.

          • dateUpdated — (String)

            The date on which the infrastructure configuration was last updated.

          • resourceTags — (map<String>)

            The tags attached to the resource created by Image Builder.

          • instanceMetadataOptions — (map)

            The instance metadata option settings for the infrastructure configuration.

            • httpTokens — (String)

              Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

              • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

              • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

              The default setting is optional.

            • httpPutResponseHopLimit — (Integer)

              Limit the number of hops that an instance metadata request can traverse to reach its destination.

          • tags — (map<String>)

            The tags of the infrastructure configuration.

        • distributionConfiguration — (map)

          The distribution configuration used when creating this image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the distribution configuration.

          • name — (String)

            The name of the distribution configuration.

          • description — (String)

            The description of the distribution configuration.

          • distributions — (Array<map>)

            The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.

            • region — required — (String)

              The target Region.

            • amiDistributionConfiguration — (map)

              The specific AMI settings; for example, launch permissions or AMI tags.

              • name — (String)

                The name of the output AMI.

              • description — (String)

                The description of the distribution configuration. Minimum and maximum length are in characters.

              • targetAccountIds — (Array<String>)

                The ID of an account to which you want to distribute an image.

              • amiTags — (map<String>)

                The tags to apply to AMIs distributed to this Region.

              • kmsKeyId — (String)

                The KMS key identifier used to encrypt the distributed image.

              • launchPermission — (map)

                Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

                • userIds — (Array<String>)

                  The Amazon Web Services account ID.

                • userGroups — (Array<String>)

                  The name of the group.

            • containerDistributionConfiguration — (map)

              Container distribution settings for encryption, licensing, and sharing in a specific Region.

              • description — (String)

                The description of the container distribution configuration.

              • containerTags — (Array<String>)

                Tags that are attached to the container distribution configuration.

              • targetRepository — required — (map)

                The destination repository for the container distribution configuration.

                • service — required — (String)

                  Specifies the service in which this image was registered.

                  Possible values include:
                  • "ECR"
                • repositoryName — required — (String)

                  The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

            • licenseConfigurationArns — (Array<String>)

              The License Manager Configuration to associate with the AMI in the specified Region.

            • launchTemplateConfigurations — (Array<map>)

              A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

              • launchTemplateId — required — (String)

                Identifies the Amazon EC2 launch template to use.

              • accountId — (String)

                The account ID that this configuration applies to.

              • setDefaultVersion — (Boolean)

                Set the specified Amazon EC2 launch template as the default launch template for the specified account.

          • timeoutMinutes — required — (Integer)

            The maximum duration in minutes for this distribution configuration.

          • dateCreated — (String)

            The date on which this distribution configuration was created.

          • dateUpdated — (String)

            The date on which this distribution configuration was last updated.

          • tags — (map<String>)

            The tags of the distribution configuration.

        • imageTestsConfiguration — (map)

          The image tests configuration used when creating this image.

          • imageTestsEnabled — (Boolean)

            Defines if tests should be executed when building this image.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

        • dateCreated — (String)

          The date on which this image was created.

        • outputResources — (map)

          The output resources produced when creating this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image state shows the image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
              • reason — (String)

                The reason for the image's status.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags of the image.

Returns:

  • (AWS.Request) —

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

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

Gets an image pipeline.

Service Reference:

Examples:

Calling the getImagePipeline operation

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

      The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipeline — (map)

        The image pipeline object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image pipeline.

        • name — (String)

          The name of the image pipeline.

        • description — (String)

          The description of the image pipeline.

        • platform — (String)

          The platform of the image pipeline.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

        • imageRecipeArn — (String)

          The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

        • containerRecipeArn — (String)

          The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

        • infrastructureConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

        • distributionConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

        • imageTestsConfiguration — (map)

          The image tests configuration of the image pipeline.

          • imageTestsEnabled — (Boolean)

            Defines if tests should be executed when building this image.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

        • schedule — (map)

          The schedule of the image pipeline.

          • scheduleExpression — (String)

            The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

            For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

          • timezone — (String)

            The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

          • pipelineExecutionStartCondition — (String)

            The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

            Possible values include:
            • "EXPRESSION_MATCH_ONLY"
            • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        • status — (String)

          The status of the image pipeline.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • dateCreated — (String)

          The date on which this image pipeline was created.

        • dateUpdated — (String)

          The date on which this image pipeline was last updated.

        • dateLastRun — (String)

          The date on which this image pipeline was last run.

        • dateNextRun — (String)

          The date on which this image pipeline will next be run.

        • tags — (map<String>)

          The tags of this image pipeline.

Returns:

  • (AWS.Request) —

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

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

Gets an image policy.

Service Reference:

Examples:

Calling the getImagePolicy operation

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

      The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The image policy object.

Returns:

  • (AWS.Request) —

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

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

Gets an image recipe.

Service Reference:

Examples:

Calling the getImageRecipe operation

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

      The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipe — (map)

        The image recipe object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image recipe.

        • type — (String)

          Specifies which type of image is created by the recipe - an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • name — (String)

          The name of the image recipe.

        • description — (String)

          The description of the image recipe.

        • platform — (String)

          The platform of the image recipe.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the image recipe.

        • version — (String)

          The version of the image recipe.

        • components — (Array<map>)

          The components of the image recipe.

          • componentArn — required — (String)

            The Amazon Resource Name (ARN) of the component.

          • parameters — (Array<map>)

            A group of parameter settings that are used to configure the component for a specific recipe.

            • name — required — (String)

              The name of the component parameter to set.

            • value — required — (Array<String>)

              Sets the value for the named component parameter.

        • parentImage — (String)

          The base image of the image recipe.

        • blockDeviceMappings — (Array<map>)

          The block device mappings to apply when creating images from this recipe.

          • deviceName — (String)

            The device to which these mappings apply.

          • ebs — (map)

            Use to manage Amazon EBS-specific configuration for this mapping.

            • encrypted — (Boolean)

              Use to configure device encryption.

            • deleteOnTermination — (Boolean)

              Use to configure delete on termination of the associated device.

            • iops — (Integer)

              Use to configure device IOPS.

            • kmsKeyId — (String)

              Use to configure the KMS key to use when encrypting the device.

            • snapshotId — (String)

              The snapshot that defines the device contents.

            • volumeSize — (Integer)

              Use to override the device's volume size.

            • volumeType — (String)

              Use to override the device's volume type.

              Possible values include:
              • "standard"
              • "io1"
              • "io2"
              • "gp2"
              • "gp3"
              • "sc1"
              • "st1"
            • throughput — (Integer)

              For GP3 volumes only – The throughput in MiB/s that the volume supports.

          • virtualName — (String)

            Use to manage instance ephemeral devices.

          • noDevice — (String)

            Use to remove a mapping from the base image.

        • dateCreated — (String)

          The date on which this image recipe was created.

        • tags — (map<String>)

          The tags of the image recipe.

        • workingDirectory — (String)

          The working directory to be used during build and test workflows.

        • additionalInstanceConfiguration — (map)

          Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

          • systemsManagerAgent — (map)

            Contains settings for the Systems Manager agent on your build instance.

            • uninstallAfterBuild — (Boolean)

              Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

          • userDataOverride — (String)

            Use this property to provide commands or a command script to run when you launch your build instance.

            Note: The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

Returns:

  • (AWS.Request) —

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

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

Gets an image recipe policy.

Service Reference:

Examples:

Calling the getImageRecipePolicy operation

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

      The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The image recipe policy object.

Returns:

  • (AWS.Request) —

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

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

Gets an infrastructure configuration.

Service Reference:

Examples:

Calling the getInfrastructureConfiguration operation

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

      The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfiguration — (map)

        The infrastructure configuration object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration.

        • name — (String)

          The name of the infrastructure configuration.

        • description — (String)

          The description of the infrastructure configuration.

        • instanceTypes — (Array<String>)

          The instance types of the infrastructure configuration.

        • instanceProfileName — (String)

          The instance profile of the infrastructure configuration.

        • securityGroupIds — (Array<String>)

          The security group IDs of the infrastructure configuration.

        • subnetId — (String)

          The subnet ID of the infrastructure configuration.

        • logging — (map)

          The logging configuration of the infrastructure configuration.

          • s3Logs — (map)

            The Amazon S3 logging configuration.

            • s3BucketName — (String)

              The Amazon S3 bucket in which to store the logs.

            • s3KeyPrefix — (String)

              The Amazon S3 path in which to store the logs.

        • keyPair — (String)

          The Amazon EC2 key pair of the infrastructure configuration.

        • terminateInstanceOnFailure — (Boolean)

          The terminate instance on failure configuration of the infrastructure configuration.

        • snsTopicArn — (String)

          The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

        • dateCreated — (String)

          The date on which the infrastructure configuration was created.

        • dateUpdated — (String)

          The date on which the infrastructure configuration was last updated.

        • resourceTags — (map<String>)

          The tags attached to the resource created by Image Builder.

        • instanceMetadataOptions — (map)

          The instance metadata option settings for the infrastructure configuration.

          • httpTokens — (String)

            Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

            • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

            • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

            The default setting is optional.

          • httpPutResponseHopLimit — (Integer)

            Limit the number of hops that an instance metadata request can traverse to reach its destination.

        • tags — (map<String>)

          The tags of the infrastructure configuration.

Returns:

  • (AWS.Request) —

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

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

Imports a component and transforms its data into a component document.

Service Reference:

Examples:

Calling the importComponent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  format: SHELL, /* required */
  name: 'STRING_VALUE', /* required */
  platform: Windows | Linux, /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  type: BUILD | TEST, /* required */
  changeDescription: 'STRING_VALUE',
  data: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  uri: 'STRING_VALUE'
};
imagebuilder.importComponent(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: {}) —
    • name — (String)

      The name of the component.

    • semanticVersion — (String)

      The semantic version of the component. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    • description — (String)

      The description of the component. Describes the contents of the component.

    • changeDescription — (String)

      The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

    • type — (String)

      The type of the component denotes whether the component is used to build the image, or only to test it.

      Possible values include:
      • "BUILD"
      • "TEST"
    • format — (String)

      The format of the resource that you want to import as a component.

      Possible values include:
      • "SHELL"
    • platform — (String)

      The platform of the component.

      Possible values include:
      • "Windows"
      • "Linux"
    • data — (String)

      The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

    • uri — (String)

      The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

    • kmsKeyId — (String)

      The ID of the KMS key that should be used to encrypt this component.

    • tags — (map<String>)

      The tags of the component.

    • clientToken — (String)

      The idempotency token of the component.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • componentBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the imported component.

Returns:

  • (AWS.Request) —

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

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

Returns the list of component build versions for the specified semantic version.

Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Service Reference:

Examples:

Calling the listComponentBuildVersions operation

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

      The component version Amazon Resource Name (ARN) whose versions you want to list.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentSummaryList — (Array<map>)

        The list of component summaries for the specified semantic version.

        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

        • name — (String)

          The name of the component.

        • version — (String)

          The version of the component.

        • platform — (String)

          The platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        • state — (map)

          Describes the current status of the component.

          • status — (String)

            The current state of the component.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the component changed state.

        • type — (String)

          The type of the component denotes whether the component is used to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • owner — (String)

          The owner of the component.

        • description — (String)

          The description of the component.

        • changeDescription — (String)

          The change description of the component.

        • dateCreated — (String)

          The date that the component was created.

        • tags — (map<String>)

          The tags associated with the component.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns the list of component build versions for the specified semantic version.

Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  byName: true || false,
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon
};
imagebuilder.listComponents(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: {}) —
    • owner — (String)

      The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • description

      • name

      • platform

      • supportedOsVersion

      • type

      • version

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • byName — (Boolean)

      Returns the list of component build versions for the specified name.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentVersionList — (Array<map>)

        The list of component semantic versions.

        Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • name — (String)

          The name of the component.

        • version — (String)

          The semantic version of the component.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • description — (String)

          The description of the component.

        • platform — (String)

          The platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        • type — (String)

          The type of the component denotes whether the component is used to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • owner — (String)

          The owner of the component.

        • dateCreated — (String)

          The date that the component was created.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns a list of container recipes.

Service Reference:

Examples:

Calling the listContainerRecipes operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon
};
imagebuilder.listContainerRecipes(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: {}) —
    • owner — (String)

      Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • containerType

      • name

      • parentImage

      • platform

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum number of results to return in the list.

    • nextToken — (String)

      Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeSummaryList — (Array<map>)

        The list of container recipes returned for the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the container recipe.

        • containerType — (String)

          Specifies the type of container, such as "Docker".

          Possible values include:
          • "DOCKER"
        • name — (String)

          The name of the container recipe.

        • platform — (String)

          The system platform for the container, such as Windows or Linux.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the container recipe.

        • parentImage — (String)

          The base image for the container recipe.

        • dateCreated — (String)

          The date when this container recipe was created.

        • tags — (map<String>)

          Tags that are attached to the container recipe.

      • nextToken — (String)

        The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

Returns:

  • (AWS.Request) —

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

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

Returns a list of distribution configurations.

Service Reference:

Examples:

Calling the listDistributionConfigurations operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listDistributionConfigurations(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: {}) —
    • filters — (Array<map>)

      You can filter on name to streamline results.

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfigurationSummaryList — (Array<map>)

        The list of distributions.

        • arn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration.

        • name — (String)

          The name of the distribution configuration.

        • description — (String)

          The description of the distribution configuration.

        • dateCreated — (String)

          The date on which the distribution configuration was created.

        • dateUpdated — (String)

          The date on which the distribution configuration was updated.

        • tags — (map<String>)

          The tags associated with the distribution configuration.

        • regions — (Array<String>)

          A list of Regions where the container image is distributed to.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns a list of image build versions.

Service Reference:

Examples:

Calling the listImageBuildVersions operation

var params = {
  imageVersionArn: 'STRING_VALUE', /* required */
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImageBuildVersions(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: {}) —
    • imageVersionArn — (String)

      The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageSummaryList — (Array<map>)

        The list of image build versions.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

        • name — (String)

          The name of the image.

        • type — (String)

          Specifies whether this is an AMI or container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          The version of the image.

        • platform — (String)

          The platform of the image.

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
          • reason — (String)

            The reason for the image's status.

        • owner — (String)

          The owner of the image.

        • dateCreated — (String)

          The date on which this image was created.

        • outputResources — (map)

          The output resources produced when creating this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image state shows the image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
              • reason — (String)

                The reason for the image's status.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags of the image.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Service Reference:

Examples:

Calling the listImagePackages operation

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

      Filter results for the ListImagePackages request by the Image Build Version ARN

    • maxResults — (Integer)

      The maxiumum number of results to return from the ListImagePackages request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePackageList — (Array<map>)

        The list of Image Packages returned in the response.

        • packageName — (String)

          The name of the package as reported to the operating system package manager.

        • packageVersion — (String)

          The version of the package as reported to the operating system package manager.

      • nextToken — (String)

        A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Returns:

  • (AWS.Request) —

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

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

Returns a list of images created by the specified pipeline.

Service Reference:

Examples:

Calling the listImagePipelineImages operation

var params = {
  imagePipelineArn: 'STRING_VALUE', /* required */
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImagePipelineImages(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: {}) —
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • version

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageSummaryList — (Array<map>)

        The list of images built by this pipeline.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

        • name — (String)

          The name of the image.

        • type — (String)

          Specifies whether this is an AMI or container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          The version of the image.

        • platform — (String)

          The platform of the image.

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
          • reason — (String)

            The reason for the image's status.

        • owner — (String)

          The owner of the image.

        • dateCreated — (String)

          The date on which this image was created.

        • outputResources — (map)

          The output resources produced when creating this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image state shows the image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
              • reason — (String)

                The reason for the image's status.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags of the image.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns a list of image pipelines.

Service Reference:

Examples:

Calling the listImagePipelines operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImagePipelines(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: {}) —
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • description

      • distributionConfigurationArn

      • imageRecipeArn

      • infrastructureConfigurationArn

      • name

      • status

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipelineList — (Array<map>)

        The list of image pipelines.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image pipeline.

        • name — (String)

          The name of the image pipeline.

        • description — (String)

          The description of the image pipeline.

        • platform — (String)

          The platform of the image pipeline.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

        • imageRecipeArn — (String)

          The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

        • containerRecipeArn — (String)

          The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

        • infrastructureConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

        • distributionConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

        • imageTestsConfiguration — (map)

          The image tests configuration of the image pipeline.

          • imageTestsEnabled — (Boolean)

            Defines if tests should be executed when building this image.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

        • schedule — (map)

          The schedule of the image pipeline.

          • scheduleExpression — (String)

            The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

            For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

          • timezone — (String)

            The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

          • pipelineExecutionStartCondition — (String)

            The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

            Possible values include:
            • "EXPRESSION_MATCH_ONLY"
            • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        • status — (String)

          The status of the image pipeline.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • dateCreated — (String)

          The date on which this image pipeline was created.

        • dateUpdated — (String)

          The date on which this image pipeline was last updated.

        • dateLastRun — (String)

          The date on which this image pipeline was last run.

        • dateNextRun — (String)

          The date on which this image pipeline will next be run.

        • tags — (map<String>)

          The tags of this image pipeline.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns a list of image recipes.

Service Reference:

Examples:

Calling the listImageRecipes operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon
};
imagebuilder.listImageRecipes(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: {}) —
    • owner — (String)

      The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • parentImage

      • platform

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeSummaryList — (Array<map>)

        The list of image pipelines.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image recipe.

        • name — (String)

          The name of the image recipe.

        • platform — (String)

          The platform of the image recipe.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the image recipe.

        • parentImage — (String)

          The base image of the image recipe.

        • dateCreated — (String)

          The date on which this image recipe was created.

        • tags — (map<String>)

          The tags of the image recipe.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns the list of images that you have access to.

Service Reference:

Examples:

Calling the listImages operation

var params = {
  byName: true || false,
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeDeprecated: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon
};
imagebuilder.listImages(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: {}) —
    • owner — (String)

      The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • byName — (Boolean)

      Requests a list of images with a specific recipe name.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

    • includeDeprecated — (Boolean)

      Includes deprecated images in the response list.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageVersionList — (Array<map>)

        The list of image semantic versions.

        Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • arn — (String)

          The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • name — (String)

          The name of this specific version of an Image Builder image.

        • type — (String)

          Specifies whether this image is an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • platform — (String)

          The platform of the image version, for example "Windows" or "Linux".

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • owner — (String)

          The owner of the image version.

        • dateCreated — (String)

          The date on which this specific version of the Image Builder image was created.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns a list of infrastructure configurations.

Service Reference:

Examples:

Calling the listInfrastructureConfigurations operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listInfrastructureConfigurations(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: {}) —
    • filters — (Array<map>)

      You can filter on name to streamline results.

      • name — (String)

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

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfigurationSummaryList — (Array<map>)

        The list of infrastructure configurations.

        • arn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration.

        • name — (String)

          The name of the infrastructure configuration.

        • description — (String)

          The description of the infrastructure configuration.

        • dateCreated — (String)

          The date on which the infrastructure configuration was created.

        • dateUpdated — (String)

          The date on which the infrastructure configuration was last updated.

        • resourceTags — (map<String>)

          The tags attached to the image created by Image Builder.

        • tags — (map<String>)

          The tags of the infrastructure configuration.

        • instanceTypes — (Array<String>)

          The instance types of the infrastructure configuration.

        • instanceProfileName — (String)

          The instance profile of the infrastructure configuration.

      • nextToken — (String)

        The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Returns the list of tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
imagebuilder.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 whose tags you want to retrieve.

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

        The tags for the specified resource.

Returns:

  • (AWS.Request) —

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

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

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putComponentPolicy operation

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

      The Amazon Resource Name (ARN) of the component that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentArn — (String)

        The Amazon Resource Name (ARN) of the component that this policy was applied to.

Returns:

  • (AWS.Request) —

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

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

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putContainerRecipePolicy operation

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

      The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

    • policy — (String)

      The policy to apply to the container recipe.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeArn — (String)

        The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

Returns:

  • (AWS.Request) —

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

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

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putImagePolicy operation

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

      The Amazon Resource Name (ARN) of the image that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageArn — (String)

        The Amazon Resource Name (ARN) of the image that this policy was applied to.

Returns:

  • (AWS.Request) —

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

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

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putImageRecipePolicy operation

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

      The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

Returns:

  • (AWS.Request) —

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

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

Manually triggers a pipeline to create an image.

Service Reference:

Examples:

Calling the startImagePipelineExecution operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imagePipelineArn: 'STRING_VALUE' /* required */
};
imagebuilder.startImagePipelineExecution(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: {}) —
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image that was created by this request.

Returns:

  • (AWS.Request) —

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

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

Adds a tag to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.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 that you want to tag.

    • tags — (map<String>)

      The tags to apply to 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 a tag from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
imagebuilder.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 that you want to untag.

    • tagKeys — (Array<String>)

      The tag keys to remove from 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.

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

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Service Reference:

Examples:

Calling the updateDistributionConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  distributionConfigurationArn: 'STRING_VALUE', /* required */
  distributions: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      amiDistributionConfiguration: {
        amiTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        description: 'STRING_VALUE',
        kmsKeyId: 'STRING_VALUE',
        launchPermission: {
          userGroups: [
            'STRING_VALUE',
            /* more items */
          ],
          userIds: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        name: 'STRING_VALUE',
        targetAccountIds: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      containerDistributionConfiguration: {
        targetRepository: { /* required */
          repositoryName: 'STRING_VALUE', /* required */
          service: ECR /* required */
        },
        containerTags: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE'
      },
      launchTemplateConfigurations: [
        {
          launchTemplateId: 'STRING_VALUE', /* required */
          accountId: 'STRING_VALUE',
          setDefaultVersion: true || false
        },
        /* more items */
      ],
      licenseConfigurationArns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  description: 'STRING_VALUE'
};
imagebuilder.updateDistributionConfiguration(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: {}) —
    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

    • description — (String)

      The description of the distribution configuration.

    • distributions — (Array<map>)

      The distributions of the distribution configuration.

      • region — required — (String)

        The target Region.

      • amiDistributionConfiguration — (map)

        The specific AMI settings; for example, launch permissions or AMI tags.

        • name — (String)

          The name of the output AMI.

        • description — (String)

          The description of the distribution configuration. Minimum and maximum length are in characters.

        • targetAccountIds — (Array<String>)

          The ID of an account to which you want to distribute an image.

        • amiTags — (map<String>)

          The tags to apply to AMIs distributed to this Region.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the distributed image.

        • launchPermission — (map)

          Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

          • userIds — (Array<String>)

            The Amazon Web Services account ID.

          • userGroups — (Array<String>)

            The name of the group.

      • containerDistributionConfiguration — (map)

        Container distribution settings for encryption, licensing, and sharing in a specific Region.

        • description — (String)

          The description of the container distribution configuration.

        • containerTags — (Array<String>)

          Tags that are attached to the container distribution configuration.

        • targetRepository — required — (map)

          The destination repository for the container distribution configuration.

          • service — required — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryName — required — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

      • licenseConfigurationArns — (Array<String>)

        The License Manager Configuration to associate with the AMI in the specified Region.

      • launchTemplateConfigurations — (Array<map>)

        A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

        • launchTemplateId — required — (String)

          Identifies the Amazon EC2 launch template to use.

        • accountId — (String)

          The account ID that this configuration applies to.

        • setDefaultVersion — (Boolean)

          Set the specified Amazon EC2 launch template as the default launch template for the specified account.

    • clientToken — (String)

      The idempotency token of the distribution configuration.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.

Returns:

  • (AWS.Request) —

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

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

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Note: UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

Service Reference:

Examples:

Calling the updateImagePipeline operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imagePipelineArn: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  imageRecipeArn: 'STRING_VALUE',
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  schedule: {
    pipelineExecutionStartCondition: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
    scheduleExpression: 'STRING_VALUE',
    timezone: 'STRING_VALUE'
  },
  status: DISABLED | ENABLED
};
imagebuilder.updateImagePipeline(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: {}) —
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline that you want to update.

    • description — (String)

      The description of the image pipeline.

    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container pipeline to update.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

    • imageTestsConfiguration — (map)

      The image test configuration of the image pipeline.

      • imageTestsEnabled — (Boolean)

        Defines if tests should be executed when building this image.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • schedule — (map)

      The schedule of the image pipeline.

      • scheduleExpression — (String)

        The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

        For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

      • timezone — (String)

        The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

      • pipelineExecutionStartCondition — (String)

        The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

        Possible values include:
        • "EXPRESSION_MATCH_ONLY"
        • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    • status — (String)

      The status of the image pipeline.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • clientToken — (String)

      The idempotency token used to make this request idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

Returns:

  • (AWS.Request) —

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

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

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Service Reference:

Examples:

Calling the updateInfrastructureConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  instanceProfileName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  instanceMetadataOptions: {
    httpPutResponseHopLimit: 'NUMBER_VALUE',
    httpTokens: 'STRING_VALUE'
  },
  instanceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  keyPair: 'STRING_VALUE',
  logging: {
    s3Logs: {
      s3BucketName: 'STRING_VALUE',
      s3KeyPrefix: 'STRING_VALUE'
    }
  },
  resourceTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  snsTopicArn: 'STRING_VALUE',
  subnetId: 'STRING_VALUE',
  terminateInstanceOnFailure: true || false
};
imagebuilder.updateInfrastructureConfiguration(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: {}) —
    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

    • description — (String)

      The description of the infrastructure configuration.

    • instanceTypes — (Array<String>)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

    • instanceProfileName — (String)

      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • securityGroupIds — (Array<String>)

      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • subnetId — (String)

      The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

    • logging — (map)

      The logging configuration of the infrastructure configuration.

      • s3Logs — (map)

        The Amazon S3 logging configuration.

        • s3BucketName — (String)

          The Amazon S3 bucket in which to store the logs.

        • s3KeyPrefix — (String)

          The Amazon S3 path in which to store the logs.

    • keyPair — (String)

      The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

    • terminateInstanceOnFailure — (Boolean)

      The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

    • snsTopicArn — (String)

      The SNS topic on which to send image build events.

    • clientToken — (String)

      The idempotency token used to make this request idempotent.

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

      The tags attached to the resource created by Image Builder.

    • instanceMetadataOptions — (map)

      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

      • httpTokens — (String)

        Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

        • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

        • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

        The default setting is optional.

      • httpPutResponseHopLimit — (Integer)

        Limit the number of hops that an instance metadata request can traverse to reach its 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The idempotency token used to make this request idempotent.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

Returns:

  • (AWS.Request) —

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