AWS.Imagebuilder (aws-elixir v0.8.0) View Source

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.

Link to this section 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 distribution configuration.

Creates a new infrastructure configuration.

Deletes a component build version.

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

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

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

Returns a list of container recipes.

Returns a list of distribution configurations.

Returns a list of image build versions.

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

Returns a list of images created by the specified pipeline.

Returns a list of image pipelines.

Returns a list of image recipes.

Returns the list of images that you have access to.

Returns a list of infrastructure configurations.

Returns the list of tags for the specified resource.

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.

Manually triggers a pipeline to create an image.

Updates a new distribution configuration.

Updates a new infrastructure configuration.

Link to this section Functions

Link to this function

cancel_image_creation(client, input, options \\ [])

View Source

CancelImageCreation cancels the creation of Image.

This operation can only be used on images in a non-terminal state.

Link to this function

create_component(client, input, options \\ [])

View Source

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

Link to this function

create_container_recipe(client, input, options \\ [])

View Source

Creates a new container recipe.

Container recipes define how images are configured, tested, and assessed.

Link to this function

create_distribution_configuration(client, input, options \\ [])

View Source

Creates a new distribution configuration.

Distribution configurations define and configure the outputs of your pipeline.

Link to this function

create_image(client, input, options \\ [])

View Source

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.

Link to this function

create_image_pipeline(client, input, options \\ [])

View Source

Creates a new image pipeline.

Image pipelines enable you to automate the creation and distribution of images.

Link to this function

create_image_recipe(client, input, options \\ [])

View Source

Creates a new image recipe.

Image recipes define how images are configured, tested, and assessed.

Link to this function

create_infrastructure_configuration(client, input, options \\ [])

View Source

Creates a new infrastructure configuration.

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

Link to this function

delete_component(client, input, options \\ [])

View Source

Deletes a component build version.

Link to this function

delete_container_recipe(client, input, options \\ [])

View Source

Deletes a container recipe.

Link to this function

delete_distribution_configuration(client, input, options \\ [])

View Source

Deletes a distribution configuration.

Link to this function

delete_image(client, input, options \\ [])

View Source

Deletes an image.

Link to this function

delete_image_pipeline(client, input, options \\ [])

View Source

Deletes an image pipeline.

Link to this function

delete_image_recipe(client, input, options \\ [])

View Source

Deletes an image recipe.

Link to this function

delete_infrastructure_configuration(client, input, options \\ [])

View Source

Deletes an infrastructure configuration.

Link to this function

get_component(client, component_build_version_arn, options \\ [])

View Source

Gets a component object.

Link to this function

get_component_policy(client, component_arn, options \\ [])

View Source

Gets a component policy.

Link to this function

get_container_recipe(client, container_recipe_arn, options \\ [])

View Source

Retrieves a container recipe.

Link to this function

get_container_recipe_policy(client, container_recipe_arn, options \\ [])

View Source

Retrieves the policy for a container recipe.

Link to this function

get_distribution_configuration(client, distribution_configuration_arn, options \\ [])

View Source

Gets a distribution configuration.

Link to this function

get_image(client, image_build_version_arn, options \\ [])

View Source

Gets an image.

Link to this function

get_image_pipeline(client, image_pipeline_arn, options \\ [])

View Source

Gets an image pipeline.

Link to this function

get_image_policy(client, image_arn, options \\ [])

View Source

Gets an image policy.

Link to this function

get_image_recipe(client, image_recipe_arn, options \\ [])

View Source

Gets an image recipe.

Link to this function

get_image_recipe_policy(client, image_recipe_arn, options \\ [])

View Source

Gets an image recipe policy.

Link to this function

get_infrastructure_configuration(client, infrastructure_configuration_arn, options \\ [])

View Source

Gets an infrastructure configuration.

Link to this function

import_component(client, input, options \\ [])

View Source

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

Link to this function

list_component_build_versions(client, input, options \\ [])

View Source

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

Link to this function

list_components(client, input, options \\ [])

View Source

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

Link to this function

list_container_recipes(client, input, options \\ [])

View Source

Returns a list of container recipes.

Link to this function

list_distribution_configurations(client, input, options \\ [])

View Source

Returns a list of distribution configurations.

Link to this function

list_image_build_versions(client, input, options \\ [])

View Source

Returns a list of image build versions.

Link to this function

list_image_packages(client, input, options \\ [])

View Source

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

Link to this function

list_image_pipeline_images(client, input, options \\ [])

View Source

Returns a list of images created by the specified pipeline.

Link to this function

list_image_pipelines(client, input, options \\ [])

View Source

Returns a list of image pipelines.

Link to this function

list_image_recipes(client, input, options \\ [])

View Source

Returns a list of image recipes.

Link to this function

list_images(client, input, options \\ [])

View Source

Returns the list of images that you have access to.

Link to this function

list_infrastructure_configurations(client, input, options \\ [])

View Source

Returns a list of infrastructure configurations.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns the list of tags for the specified resource.

Link to this function

put_component_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_container_recipe_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_image_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_image_recipe_policy(client, input, options \\ [])

View Source

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.

Link to this function

start_image_pipeline_execution(client, input, options \\ [])

View Source

Manually triggers a pipeline to create an image.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds a tag to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

update_distribution_configuration(client, input, options \\ [])

View Source

Updates a new distribution configuration.

Distribution configurations define and configure the outputs of your pipeline.

Link to this function

update_image_pipeline(client, input, options \\ [])

View Source

Updates an image pipeline.

Image pipelines enable you to automate the creation and distribution of images.

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.

Link to this function

update_infrastructure_configuration(client, input, options \\ [])

View Source

Updates a new infrastructure configuration.

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