View Source aws_imagebuilder (aws v1.0.4)
Summary
Functions
CancelImageCreation cancels the creation of Image.
Creates a new component that can be used to build, validate, test, and assess your image.
Creates a new container recipe.
Creates a new distribution configuration.
Creates a new image.
Creates a new image pipeline.
Creates a new image recipe.
Creates a new infrastructure configuration.
Deletes an Image Builder image resource.
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data.
Returns the list of component build versions for the specified semantic version.
Returns the list of components that can be filtered by name, or by using the listed filters
to streamline results.
Returns a list of image scan aggregations for your account.
Returns the list of images that you have access to.
Applies a policy to a component.
Applies a policy to a container image.
Applies a policy to an image.
Applies a policy to an image recipe.
WaitForAction
step.Updates a new distribution configuration.
Updates an image pipeline.
Updates a new infrastructure configuration.
Functions
CancelImageCreation cancels the creation of Image.
This operation can only be used on images in a non-terminal state.Creates a new component that can be used to build, validate, test, and assess your image.
The component is based on a YAML document that you specify using exactly one of the following methods:
Inline, using the
data
property in the request body.A URL that points to a YAML document file stored in Amazon S3, using the
uri
property in the request body.
Creates a new container recipe.
Container recipes define how images are configured, tested, and assessed.Creates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.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.Creates a new image pipeline.
Image pipelines enable you to automate the creation and distribution of images.Creates a new image recipe.
Image recipes define how images are configured, tested, and assessed.Creates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.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.
To deregister an EC2 Linux AMI, see Deregister your Linux AMI: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html in the Amazon EC2 User Guide .
To deregister an EC2 Windows AMI, see Deregister your Windows AMI: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html in the Amazon EC2 Windows Guide .
To delete a container image from Amazon ECR, see Deleting an image: https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html in the Amazon ECR User Guide.
get_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap)
View Sourceget_component(Client, ComponentBuildVersionArn, QueryMap, HeadersMap, Options0)
View Sourceget_component_policy(Client, ComponentArn, QueryMap, HeadersMap, Options0)
View Sourceget_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap)
View Sourceget_container_recipe(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
View Sourceget_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap)
View Sourceget_container_recipe_policy(Client, ContainerRecipeArn, QueryMap, HeadersMap, Options0)
View Sourceget_distribution_configuration(Client, DistributionConfigurationArn)
View Sourceget_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap)
View Sourceget_distribution_configuration(Client, DistributionConfigurationArn, QueryMap, HeadersMap, Options0)
View Sourceget_image(Client, ImageBuildVersionArn, QueryMap, HeadersMap, Options0)
View Sourceget_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap)
View Sourceget_image_pipeline(Client, ImagePipelineArn, QueryMap, HeadersMap, Options0)
View Sourceget_image_policy(Client, ImageArn, QueryMap, HeadersMap, Options0)
View Sourceget_image_recipe(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
View Sourceget_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap)
View Sourceget_image_recipe_policy(Client, ImageRecipeArn, QueryMap, HeadersMap, Options0)
View Sourceget_infrastructure_configuration(Client, InfrastructureConfigurationArn)
View Sourceget_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap)
View Sourceget_infrastructure_configuration(Client, InfrastructureConfigurationArn, QueryMap, HeadersMap, Options0)
View Sourceget_lifecycle_execution(Client, LifecycleExecutionId, QueryMap, HeadersMap)
View Sourceget_lifecycle_execution(Client, LifecycleExecutionId, QueryMap, HeadersMap, Options0)
View Sourceget_lifecycle_policy(Client, LifecyclePolicyArn, QueryMap, HeadersMap)
View Sourceget_lifecycle_policy(Client, LifecyclePolicyArn, QueryMap, HeadersMap, Options0)
View Sourceget_workflow(Client, WorkflowBuildVersionArn, QueryMap, HeadersMap)
View Sourceget_workflow(Client, WorkflowBuildVersionArn, QueryMap, HeadersMap, Options0)
View Sourceget_workflow_execution(Client, WorkflowExecutionId, QueryMap, HeadersMap)
View Sourceget_workflow_execution(Client, WorkflowExecutionId, QueryMap, HeadersMap, Options0)
View Sourceget_workflow_step_execution(Client, StepExecutionId, QueryMap, HeadersMap)
View Sourceget_workflow_step_execution(Client, StepExecutionId, QueryMap, HeadersMap, Options0)
View SourceWhen you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data.
The Amazon EC2 API ImportImage: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image: https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html
You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.Returns the list of component build versions for the specified semantic version.
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.Returns the list of components that can be filtered by name, or by using the listed filters
to streamline results.
Newly created components can take up to two minutes to appear in the ListComponents API Results.
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.Returns a list of image scan aggregations for your account.
You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn
filter. If you don't specify a filter, Image Builder returns an aggregation for your account.
To streamline results, you can use the following filters in your request:
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Returns the list of images that you have access to.
Newly created images can take up to two minutes to appear in the ListImages API Results.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceApplies a policy to a component.
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 APIPutComponentPolicy
, 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.
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 APIPutContainerImagePolicy
, 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.
Applies a policy to an 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 APIPutImagePolicy
, 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.
Applies a policy to an image recipe.
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 APIPutImageRecipePolicy
, 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.
WaitForAction
step.
Updates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.Updates an image pipeline.
Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn
or an imageRecipeArn
.
Updates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.