We recommend new projects start with resources from the AWS provider.
aws-native.imagebuilder.Image
We recommend new projects start with resources from the AWS provider.
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,
deletion_settings: Optional[ImageDeletionSettingsArgs] = None,
distribution_configuration_arn: Optional[str] = None,
enhanced_image_metadata_enabled: Optional[bool] = None,
execution_role: Optional[str] = None,
image_pipeline_execution_settings: Optional[ImagePipelineExecutionSettingsArgs] = 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,
logging_configuration: Optional[ImageLoggingConfigurationArgs] = 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)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:
- Container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- Deletion
Settings Pulumi.Aws Native. Image Builder. Inputs. Image Deletion Settings - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- Distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration.
- Enhanced
Image boolMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- Execution
Role string - The execution role name/ARN for the image build, if provided
- Image
Pipeline Pulumi.Execution Settings Aws Native. Image Builder. Inputs. Image Pipeline Execution Settings - The image pipeline execution settings of the image.
- Image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- Image
Scanning Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Scanning Configuration - Contains settings for vulnerability scans.
- Image
Tests Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Tests Configuration - The image tests configuration used when creating this image.
- Infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- Logging
Configuration Pulumi.Aws Native. Image Builder. Inputs. Image Logging Configuration - The logging configuration settings for the image.
- Dictionary<string, string>
- The tags associated with the image.
- Workflows
List<Pulumi.
Aws Native. Image Builder. Inputs. Image Workflow Configuration> - Workflows to define the image build process
- Container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- Deletion
Settings ImageDeletion Settings Args - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- Distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration.
- Enhanced
Image boolMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- Execution
Role string - The execution role name/ARN for the image build, if provided
- Image
Pipeline ImageExecution Settings Pipeline Execution Settings Args - The image pipeline execution settings of the image.
- Image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- Image
Scanning ImageConfiguration Scanning Configuration Args - Contains settings for vulnerability scans.
- Image
Tests ImageConfiguration Tests Configuration Args - The image tests configuration used when creating this image.
- Infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- Logging
Configuration ImageLogging Configuration Args - The logging configuration settings for the image.
- map[string]string
- The tags associated with the image.
- Workflows
[]Image
Workflow Configuration Args - Workflows to define the image build process
- container
Recipe StringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- deletion
Settings ImageDeletion Settings - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- distribution
Configuration StringArn - The Amazon Resource Name (ARN) of the distribution configuration.
- enhanced
Image BooleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role String - The execution role name/ARN for the image build, if provided
- image
Pipeline ImageExecution Settings Pipeline Execution Settings - The image pipeline execution settings of the image.
- image
Recipe StringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning ImageConfiguration Scanning Configuration - Contains settings for vulnerability scans.
- image
Tests ImageConfiguration Tests Configuration - The image tests configuration used when creating this image.
- infrastructure
Configuration StringArn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- logging
Configuration ImageLogging Configuration - The logging configuration settings for the image.
- Map<String,String>
- The tags associated with the image.
- workflows
List<Image
Workflow Configuration> - Workflows to define the image build process
- container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- deletion
Settings ImageDeletion Settings - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration.
- enhanced
Image booleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role string - The execution role name/ARN for the image build, if provided
- image
Pipeline ImageExecution Settings Pipeline Execution Settings - The image pipeline execution settings of the image.
- image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning ImageConfiguration Scanning Configuration - Contains settings for vulnerability scans.
- image
Tests ImageConfiguration Tests Configuration - The image tests configuration used when creating this image.
- infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- logging
Configuration ImageLogging Configuration - The logging configuration settings for the image.
- {[key: string]: string}
- The tags associated with the image.
- workflows
Image
Workflow Configuration[] - Workflows to define the image build process
- container_
recipe_ strarn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- deletion_
settings ImageDeletion Settings Args - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- distribution_
configuration_ strarn - The Amazon Resource Name (ARN) of the distribution configuration.
- enhanced_
image_ boolmetadata_ enabled - 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_
pipeline_ Imageexecution_ settings Pipeline Execution Settings Args - The image pipeline execution settings of the image.
- image_
recipe_ strarn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image_
scanning_ Imageconfiguration Scanning Configuration Args - Contains settings for vulnerability scans.
- image_
tests_ Imageconfiguration Tests Configuration Args - The image tests configuration used when creating this image.
- infrastructure_
configuration_ strarn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- logging_
configuration ImageLogging Configuration Args - The logging configuration settings for the image.
- Mapping[str, str]
- The tags associated with the image.
- workflows
Sequence[Image
Workflow Configuration Args] - Workflows to define the image build process
- container
Recipe StringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- deletion
Settings Property Map - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
- distribution
Configuration StringArn - The Amazon Resource Name (ARN) of the distribution configuration.
- enhanced
Image BooleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role String - The execution role name/ARN for the image build, if provided
- image
Pipeline Property MapExecution Settings - The image pipeline execution settings of the image.
- image
Recipe StringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning Property MapConfiguration - Contains settings for vulnerability scans.
- image
Tests Property MapConfiguration - The image tests configuration used when creating this image.
- infrastructure
Configuration StringArn - The Amazon Resource Name (ARN) of the infrastructure configuration.
- logging
Configuration Property Map - The logging configuration settings for the image.
- 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.
- Image
Id string - The AMI ID of the EC2 AMI in current region.
- Image
Uri string - URI for containers created in current Region with default ECR image tag
- Latest
Version Pulumi.Aws Native. Image Builder. Outputs. Image Latest Version - The latest version references of the image.
- 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.
- Image
Id string - The AMI ID of the EC2 AMI in current region.
- Image
Uri string - URI for containers created in current Region with default ECR image tag
- Latest
Version ImageLatest Version - The latest version references of the image.
- 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.
- image
Id String - The AMI ID of the EC2 AMI in current region.
- image
Uri String - URI for containers created in current Region with default ECR image tag
- latest
Version ImageLatest Version - The latest version references of the image.
- 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.
- image
Id string - The AMI ID of the EC2 AMI in current region.
- image
Uri string - URI for containers created in current Region with default ECR image tag
- latest
Version ImageLatest Version - The latest version references of the image.
- 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
- latest_
version ImageLatest Version - The latest version references of the image.
- 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.
- image
Id String - The AMI ID of the EC2 AMI in current region.
- image
Uri String - URI for containers created in current Region with default ECR image tag
- latest
Version Property Map - The latest version references of the image.
- name String
- The name of the image.
Supporting Types
ImageDeletionSettings, ImageDeletionSettingsArgs
The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.- Execution
Role string - The execution role to use for deleting the image, as well as underlying resources.
- Execution
Role string - The execution role to use for deleting the image, as well as underlying resources.
- execution
Role String - The execution role to use for deleting the image, as well as underlying resources.
- execution
Role string - The execution role to use for deleting the image, as well as underlying resources.
- execution_
role str - The execution role to use for deleting the image, as well as underlying resources.
- execution
Role String - The execution role to use for deleting the image, as well as underlying resources.
ImageEcrConfiguration, ImageEcrConfigurationArgs
Settings for Image Builder to configure the ECR repository and output container images that are scanned.- 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.
- Repository
Name 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.
- []string
- 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 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.
- 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.
- repository
Name 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.
- string[]
- 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 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.
- 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.
- 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.
- repository
Name 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.
ImageLatestVersion, ImageLatestVersionArgs
The latest version references of the image.- Arn string
- The latest version ARN of the created image.
- Major string
- The latest version ARN of the created image, with the same major version.
- Minor string
- The latest version ARN of the created image, with the same minor version.
- Patch string
- The latest version ARN of the created image, with the same patch version.
- Arn string
- The latest version ARN of the created image.
- Major string
- The latest version ARN of the created image, with the same major version.
- Minor string
- The latest version ARN of the created image, with the same minor version.
- Patch string
- The latest version ARN of the created image, with the same patch version.
- arn String
- The latest version ARN of the created image.
- major String
- The latest version ARN of the created image, with the same major version.
- minor String
- The latest version ARN of the created image, with the same minor version.
- patch String
- The latest version ARN of the created image, with the same patch version.
- arn string
- The latest version ARN of the created image.
- major string
- The latest version ARN of the created image, with the same major version.
- minor string
- The latest version ARN of the created image, with the same minor version.
- patch string
- The latest version ARN of the created image, with the same patch version.
- arn String
- The latest version ARN of the created image.
- major String
- The latest version ARN of the created image, with the same major version.
- minor String
- The latest version ARN of the created image, with the same minor version.
- patch String
- The latest version ARN of the created image, with the same patch version.
ImageLoggingConfiguration, ImageLoggingConfigurationArgs
The logging configuration settings for the image.- Log
Group stringName - The name of the log group for image build logs.
- Log
Group stringName - The name of the log group for image build logs.
- log
Group StringName - The name of the log group for image build logs.
- log
Group stringName - The name of the log group for image build logs.
- log_
group_ strname - The name of the log group for image build logs.
- log
Group StringName - The name of the log group for image build logs.
ImagePipelineExecutionSettings, ImagePipelineExecutionSettingsArgs
The settings for starting an image pipeline execution.- Deployment
Id string - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- On
Update bool - Whether to trigger the image pipeline when the pipeline is updated. False by default.
- Deployment
Id string - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- On
Update bool - Whether to trigger the image pipeline when the pipeline is updated. False by default.
- deployment
Id String - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- on
Update Boolean - Whether to trigger the image pipeline when the pipeline is updated. False by default.
- deployment
Id string - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- on
Update boolean - Whether to trigger the image pipeline when the pipeline is updated. False by default.
- deployment_
id str - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- on_
update bool - Whether to trigger the image pipeline when the pipeline is updated. False by default.
- deployment
Id String - The deployment ID of the pipeline, used to trigger new image pipeline executions.
- on
Update Boolean - Whether to trigger the image pipeline when the pipeline is updated. False by default.
ImageScanningConfiguration, ImageScanningConfigurationArgs
Contains settings for Image Builder image resource and container image scans.- Ecr
Configuration Pulumi.Aws Native. Image Builder. Inputs. Image Ecr Configuration - Contains ECR settings for vulnerability scans.
- Image
Scanning boolEnabled - 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 ImageEcr Configuration - Contains ECR settings for vulnerability scans.
- Image
Scanning boolEnabled - 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 ImageEcr Configuration - Contains ECR settings for vulnerability scans.
- image
Scanning BooleanEnabled - 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 ImageEcr Configuration - Contains ECR settings for vulnerability scans.
- image
Scanning booleanEnabled - 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 ImageEcr Configuration - Contains ECR settings for vulnerability scans.
- image_
scanning_ boolenabled - 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 Property Map - Contains ECR settings for vulnerability scans.
- image
Scanning BooleanEnabled - 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
The image tests configuration used when creating this image.- Image
Tests boolEnabled - ImageTestsEnabled
- Timeout
Minutes int - TimeoutMinutes
- Image
Tests boolEnabled - ImageTestsEnabled
- Timeout
Minutes int - TimeoutMinutes
- image
Tests BooleanEnabled - ImageTestsEnabled
- timeout
Minutes Integer - TimeoutMinutes
- image
Tests booleanEnabled - ImageTestsEnabled
- timeout
Minutes number - TimeoutMinutes
- image_
tests_ boolenabled - ImageTestsEnabled
- timeout_
minutes int - TimeoutMinutes
- image
Tests BooleanEnabled - ImageTestsEnabled
- timeout
Minutes Number - TimeoutMinutes
ImageWorkflowConfiguration, ImageWorkflowConfigurationArgs
The workflow configuration of the image- On
Failure Pulumi.Aws Native. Image Builder. Image Workflow Configuration On Failure - Define execution decision in case of workflow failure
- Parallel
Group string - The parallel group name
- Parameters
List<Pulumi.
Aws Native. Image Builder. Inputs. Image Workflow Parameter> - The parameters associated with the workflow
- Workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- On
Failure ImageWorkflow Configuration On Failure - Define execution decision in case of workflow failure
- Parallel
Group string - The parallel group name
- Parameters
[]Image
Workflow Parameter - The parameters associated with the workflow
- Workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- on
Failure ImageWorkflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel
Group String - The parallel group name
- parameters
List<Image
Workflow Parameter> - The parameters associated with the workflow
- workflow
Arn String - The Amazon Resource Name (ARN) of the workflow
- on
Failure ImageWorkflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel
Group string - The parallel group name
- parameters
Image
Workflow Parameter[] - The parameters associated with the workflow
- workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- on_
failure ImageWorkflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel_
group str - The parallel group name
- parameters
Sequence[Image
Workflow Parameter] - The parameters associated with the workflow
- workflow_
arn str - The Amazon Resource Name (ARN) of the workflow
- on
Failure "CONTINUE" | "ABORT" - Define execution decision in case of workflow failure
- parallel
Group String - The parallel group name
- parameters List<Property Map>
- The parameters associated with the workflow
- workflow
Arn String - The Amazon Resource Name (ARN) of the workflow
ImageWorkflowConfigurationOnFailure, ImageWorkflowConfigurationOnFailureArgs
- Continue
- CONTINUE
- Abort
- ABORT
- Image
Workflow Configuration On Failure Continue - CONTINUE
- Image
Workflow Configuration On Failure Abort - ABORT
- Continue
- CONTINUE
- Abort
- ABORT
- Continue
- CONTINUE
- Abort
- ABORT
- CONTINUE_
- CONTINUE
- ABORT
- ABORT
- "CONTINUE"
- CONTINUE
- "ABORT"
- ABORT
ImageWorkflowParameter, ImageWorkflowParameterArgs
A parameter associated with the workflowPackage Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
