Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. imagebuilder
  5. Image

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.Image

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::ImageBuilder::Image

    Create Image Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Image(name: string, args?: ImageArgs, opts?: CustomResourceOptions);
    @overload
def Image(resource_name: str,
          args: Optional[ImageArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          container_recipe_arn: Optional[str] = None,
          distribution_configuration_arn: Optional[str] = None,
          enhanced_image_metadata_enabled: Optional[bool] = None,
          execution_role: Optional[str] = None,
          image_recipe_arn: Optional[str] = None,
          image_scanning_configuration: Optional[ImageScanningConfigurationArgs] = None,
          image_tests_configuration: Optional[ImageTestsConfigurationArgs] = None,
          infrastructure_configuration_arn: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None,
          workflows: Optional[Sequence[ImageWorkflowConfigurationArgs]] = None)
    func NewImage(ctx *Context, name string, args *ImageArgs, opts ...ResourceOption) (*Image, error)
    public Image(string name, ImageArgs? args = null, CustomResourceOptions? opts = null)
    public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

    type: aws-native:imagebuilder:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Image Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Image resource accepts the following input properties:

    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.
    EnhancedImageMetadataEnabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    ExecutionRole string
    The execution role name/ARN for the image build, if provided
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImageScanningConfiguration
    Contains settings for vulnerability scans.
    ImageTestsConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImageTestsConfiguration
    The image tests configuration used when creating this image.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    Tags Dictionary<string, string>
    The tags associated with the image.
    Workflows List<Pulumi.AwsNative.ImageBuilder.Inputs.ImageWorkflowConfiguration>
    Workflows to define the image build process
    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.
    EnhancedImageMetadataEnabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    ExecutionRole string
    The execution role name/ARN for the image build, if provided
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration ImageScanningConfigurationArgs
    Contains settings for vulnerability scans.
    ImageTestsConfiguration ImageTestsConfigurationArgs
    The image tests configuration used when creating this image.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    Tags map[string]string
    The tags associated with the image.
    Workflows []ImageWorkflowConfigurationArgs
    Workflows to define the image build process
    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.
    enhancedImageMetadataEnabled Boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole String
    The execution role name/ARN for the image build, if provided
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImageTestsConfiguration
    The image tests configuration used when creating this image.
    infrastructureConfigurationArn String
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    tags Map<String,String>
    The tags associated with the image.
    workflows List<ImageWorkflowConfiguration>
    Workflows to define the image build process
    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.
    enhancedImageMetadataEnabled boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole string
    The execution role name/ARN for the image build, if provided
    imageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImageTestsConfiguration
    The image tests configuration used when creating this image.
    infrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    tags {[key: string]: string}
    The tags associated with the image.
    workflows ImageWorkflowConfiguration[]
    Workflows to define the image build process
    container_recipe_arn str
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    distribution_configuration_arn str
    The Amazon Resource Name (ARN) of the distribution configuration.
    enhanced_image_metadata_enabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    execution_role str
    The execution role name/ARN for the image build, if provided
    image_recipe_arn str
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    image_scanning_configuration ImageScanningConfigurationArgs
    Contains settings for vulnerability scans.
    image_tests_configuration ImageTestsConfigurationArgs
    The image tests configuration used when creating this image.
    infrastructure_configuration_arn str
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    tags Mapping[str, str]
    The tags associated with the image.
    workflows Sequence[ImageWorkflowConfigurationArgs]
    Workflows to define the image build process
    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.
    enhancedImageMetadataEnabled Boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole String
    The execution role name/ARN for the image build, if provided
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration Property Map
    Contains settings for vulnerability scans.
    imageTestsConfiguration Property Map
    The image tests configuration used when creating this image.
    infrastructureConfigurationArn String
    The Amazon Resource Name (ARN) of the infrastructure configuration.
    tags Map<String>
    The tags associated with the image.
    workflows List<Property Map>
    Workflows to define the image build process

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the image.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The AMI ID of the EC2 AMI in current region.
    ImageUri string
    URI for containers created in current Region with default ECR image tag
    Name string
    The name of the image.
    Arn string
    The Amazon Resource Name (ARN) of the image.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The AMI ID of the EC2 AMI in current region.
    ImageUri string
    URI for containers created in current Region with default ECR image tag
    Name string
    The name of the image.
    arn String
    The Amazon Resource Name (ARN) of the image.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The AMI ID of the EC2 AMI in current region.
    imageUri String
    URI for containers created in current Region with default ECR image tag
    name String
    The name of the image.
    arn string
    The Amazon Resource Name (ARN) of the image.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    The AMI ID of the EC2 AMI in current region.
    imageUri string
    URI for containers created in current Region with default ECR image tag
    name string
    The name of the image.
    arn str
    The Amazon Resource Name (ARN) of the image.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    The AMI ID of the EC2 AMI in current region.
    image_uri str
    URI for containers created in current Region with default ECR image tag
    name str
    The name of the image.
    arn String
    The Amazon Resource Name (ARN) of the image.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The AMI ID of the EC2 AMI in current region.
    imageUri String
    URI for containers created in current Region with default ECR image tag
    name String
    The name of the image.

    Supporting Types

    ImageEcrConfiguration, ImageEcrConfigurationArgs

    ContainerTags List<string>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    ContainerTags []string
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags List<String>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags string[]
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    container_tags Sequence[str]
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repository_name str
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags List<String>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.

    ImageScanningConfiguration, ImageScanningConfigurationArgs

    EcrConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImageEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    EcrConfiguration ImageEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration ImageEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled Boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration ImageEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecr_configuration ImageEcrConfiguration
    Contains ECR settings for vulnerability scans.
    image_scanning_enabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration Property Map
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled Boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

    ImageTestsConfiguration, ImageTestsConfigurationArgs

    ImageTestsEnabled bool
    ImageTestsEnabled
    TimeoutMinutes int
    TimeoutMinutes
    ImageTestsEnabled bool
    ImageTestsEnabled
    TimeoutMinutes int
    TimeoutMinutes
    imageTestsEnabled Boolean
    ImageTestsEnabled
    timeoutMinutes Integer
    TimeoutMinutes
    imageTestsEnabled boolean
    ImageTestsEnabled
    timeoutMinutes number
    TimeoutMinutes
    image_tests_enabled bool
    ImageTestsEnabled
    timeout_minutes int
    TimeoutMinutes
    imageTestsEnabled Boolean
    ImageTestsEnabled
    timeoutMinutes Number
    TimeoutMinutes

    ImageWorkflowConfiguration, ImageWorkflowConfigurationArgs

    OnFailure Pulumi.AwsNative.ImageBuilder.ImageWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters List<Pulumi.AwsNative.ImageBuilder.Inputs.ImageWorkflowParameter>
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    OnFailure ImageWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters []ImageWorkflowParameter
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImageWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup String
    The parallel group name
    parameters List<ImageWorkflowParameter>
    The parameters associated with the workflow
    workflowArn String
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImageWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup string
    The parallel group name
    parameters ImageWorkflowParameter[]
    The parameters associated with the workflow
    workflowArn string
    The Amazon Resource Name (ARN) of the workflow
    on_failure ImageWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallel_group str
    The parallel group name
    parameters Sequence[ImageWorkflowParameter]
    The parameters associated with the workflow
    workflow_arn str
    The Amazon Resource Name (ARN) of the workflow
    onFailure "CONTINUE" | "ABORT"
    Define execution decision in case of workflow failure
    parallelGroup String
    The parallel group name
    parameters List<Property Map>
    The parameters associated with the workflow
    workflowArn String
    The Amazon Resource Name (ARN) of the workflow

    ImageWorkflowConfigurationOnFailure, ImageWorkflowConfigurationOnFailureArgs

    Continue
    CONTINUE
    Abort
    ABORT
    ImageWorkflowConfigurationOnFailureContinue
    CONTINUE
    ImageWorkflowConfigurationOnFailureAbort
    ABORT
    Continue
    CONTINUE
    Abort
    ABORT
    Continue
    CONTINUE
    Abort
    ABORT
    CONTINUE_
    CONTINUE
    ABORT
    ABORT
    "CONTINUE"
    CONTINUE
    "ABORT"
    ABORT

    ImageWorkflowParameter, ImageWorkflowParameterArgs

    Name string
    The name of the workflow parameter to set.
    Value List<string>
    Sets the value for the named workflow parameter.
    Name string
    The name of the workflow parameter to set.
    Value []string
    Sets the value for the named workflow parameter.
    name String
    The name of the workflow parameter to set.
    value List<String>
    Sets the value for the named workflow parameter.
    name string
    The name of the workflow parameter to set.
    value string[]
    Sets the value for the named workflow parameter.
    name str
    The name of the workflow parameter to set.
    value Sequence[str]
    Sets the value for the named workflow parameter.
    name String
    The name of the workflow parameter to set.
    value List<String>
    Sets the value for the named workflow parameter.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native