The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ImageBuilder

NAME

Paws::ImageBuilder - Perl Interface to AWS EC2 Image Builder

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ImageBuilder');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02

METHODS

CancelImageCreation

ClientToken => Str
ImageBuildVersionArn => Str

Each argument is described in detail in: Paws::ImageBuilder::CancelImageCreation

Returns: a Paws::ImageBuilder::CancelImageCreationResponse instance

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

CreateComponent

ClientToken => Str
Name => Str
Platform => Str
SemanticVersion => Str
[ChangeDescription => Str]
[Data => Str]
[Description => Str]
[KmsKeyId => Str]
[SupportedOsVersions => ArrayRef[Str|Undef]]
[Tags => Paws::ImageBuilder::TagMap]
[Uri => Str]

Each argument is described in detail in: Paws::ImageBuilder::CreateComponent

Returns: a Paws::ImageBuilder::CreateComponentResponse instance

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

CreateContainerRecipe

ClientToken => Str
Components => ArrayRef[Paws::ImageBuilder::ComponentConfiguration]
ContainerType => Str
Name => Str
ParentImage => Str
SemanticVersion => Str
TargetRepository => Paws::ImageBuilder::TargetContainerRepository
[Description => Str]
[DockerfileTemplateData => Str]
[DockerfileTemplateUri => Str]
[ImageOsVersionOverride => Str]
[InstanceConfiguration => Paws::ImageBuilder::InstanceConfiguration]
[KmsKeyId => Str]
[PlatformOverride => Str]
[Tags => Paws::ImageBuilder::TagMap]
[WorkingDirectory => Str]

Each argument is described in detail in: Paws::ImageBuilder::CreateContainerRecipe

Returns: a Paws::ImageBuilder::CreateContainerRecipeResponse instance

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

CreateDistributionConfiguration

ClientToken => Str
Distributions => ArrayRef[Paws::ImageBuilder::Distribution]
Name => Str
[Description => Str]
[Tags => Paws::ImageBuilder::TagMap]

Each argument is described in detail in: Paws::ImageBuilder::CreateDistributionConfiguration

Returns: a Paws::ImageBuilder::CreateDistributionConfigurationResponse instance

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

CreateImage

ClientToken => Str
InfrastructureConfigurationArn => Str
[ContainerRecipeArn => Str]
[DistributionConfigurationArn => Str]
[EnhancedImageMetadataEnabled => Bool]
[ImageRecipeArn => Str]
[ImageTestsConfiguration => Paws::ImageBuilder::ImageTestsConfiguration]
[Tags => Paws::ImageBuilder::TagMap]

Each argument is described in detail in: Paws::ImageBuilder::CreateImage

Returns: a Paws::ImageBuilder::CreateImageResponse instance

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.

CreateImagePipeline

ClientToken => Str
InfrastructureConfigurationArn => Str
Name => Str
[ContainerRecipeArn => Str]
[Description => Str]
[DistributionConfigurationArn => Str]
[EnhancedImageMetadataEnabled => Bool]
[ImageRecipeArn => Str]
[ImageTestsConfiguration => Paws::ImageBuilder::ImageTestsConfiguration]
[Schedule => Paws::ImageBuilder::Schedule]
[Status => Str]
[Tags => Paws::ImageBuilder::TagMap]

Each argument is described in detail in: Paws::ImageBuilder::CreateImagePipeline

Returns: a Paws::ImageBuilder::CreateImagePipelineResponse instance

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

CreateImageRecipe

ClientToken => Str
Components => ArrayRef[Paws::ImageBuilder::ComponentConfiguration]
Name => Str
ParentImage => Str
SemanticVersion => Str
[AdditionalInstanceConfiguration => Paws::ImageBuilder::AdditionalInstanceConfiguration]
[BlockDeviceMappings => ArrayRef[Paws::ImageBuilder::InstanceBlockDeviceMapping]]
[Description => Str]
[Tags => Paws::ImageBuilder::TagMap]
[WorkingDirectory => Str]

Each argument is described in detail in: Paws::ImageBuilder::CreateImageRecipe

Returns: a Paws::ImageBuilder::CreateImageRecipeResponse instance

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

CreateInfrastructureConfiguration

ClientToken => Str
InstanceProfileName => Str
Name => Str
[Description => Str]
[InstanceTypes => ArrayRef[Str|Undef]]
[KeyPair => Str]
[Logging => Paws::ImageBuilder::Logging]
[ResourceTags => Paws::ImageBuilder::ResourceTagMap]
[SecurityGroupIds => ArrayRef[Str|Undef]]
[SnsTopicArn => Str]
[SubnetId => Str]
[Tags => Paws::ImageBuilder::TagMap]
[TerminateInstanceOnFailure => Bool]

Each argument is described in detail in: Paws::ImageBuilder::CreateInfrastructureConfiguration

Returns: a Paws::ImageBuilder::CreateInfrastructureConfigurationResponse instance

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

DeleteComponent

ComponentBuildVersionArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteComponent

Returns: a Paws::ImageBuilder::DeleteComponentResponse instance

Deletes a component build version.

DeleteContainerRecipe

ContainerRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteContainerRecipe

Returns: a Paws::ImageBuilder::DeleteContainerRecipeResponse instance

Deletes a container recipe.

DeleteDistributionConfiguration

DistributionConfigurationArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteDistributionConfiguration

Returns: a Paws::ImageBuilder::DeleteDistributionConfigurationResponse instance

Deletes a distribution configuration.

DeleteImage

ImageBuildVersionArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteImage

Returns: a Paws::ImageBuilder::DeleteImageResponse instance

Deletes an image.

DeleteImagePipeline

ImagePipelineArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteImagePipeline

Returns: a Paws::ImageBuilder::DeleteImagePipelineResponse instance

Deletes an image pipeline.

DeleteImageRecipe

ImageRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteImageRecipe

Returns: a Paws::ImageBuilder::DeleteImageRecipeResponse instance

Deletes an image recipe.

DeleteInfrastructureConfiguration

InfrastructureConfigurationArn => Str

Each argument is described in detail in: Paws::ImageBuilder::DeleteInfrastructureConfiguration

Returns: a Paws::ImageBuilder::DeleteInfrastructureConfigurationResponse instance

Deletes an infrastructure configuration.

GetComponent

ComponentBuildVersionArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetComponent

Returns: a Paws::ImageBuilder::GetComponentResponse instance

Gets a component object.

GetComponentPolicy

ComponentArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetComponentPolicy

Returns: a Paws::ImageBuilder::GetComponentPolicyResponse instance

Gets a component policy.

GetContainerRecipe

ContainerRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetContainerRecipe

Returns: a Paws::ImageBuilder::GetContainerRecipeResponse instance

Retrieves a container recipe.

GetContainerRecipePolicy

ContainerRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetContainerRecipePolicy

Returns: a Paws::ImageBuilder::GetContainerRecipePolicyResponse instance

Retrieves the policy for a container recipe.

GetDistributionConfiguration

DistributionConfigurationArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetDistributionConfiguration

Returns: a Paws::ImageBuilder::GetDistributionConfigurationResponse instance

Gets a distribution configuration.

GetImage

ImageBuildVersionArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetImage

Returns: a Paws::ImageBuilder::GetImageResponse instance

Gets an image.

GetImagePipeline

ImagePipelineArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetImagePipeline

Returns: a Paws::ImageBuilder::GetImagePipelineResponse instance

Gets an image pipeline.

GetImagePolicy

ImageArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetImagePolicy

Returns: a Paws::ImageBuilder::GetImagePolicyResponse instance

Gets an image policy.

GetImageRecipe

ImageRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetImageRecipe

Returns: a Paws::ImageBuilder::GetImageRecipeResponse instance

Gets an image recipe.

GetImageRecipePolicy

ImageRecipeArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetImageRecipePolicy

Returns: a Paws::ImageBuilder::GetImageRecipePolicyResponse instance

Gets an image recipe policy.

GetInfrastructureConfiguration

InfrastructureConfigurationArn => Str

Each argument is described in detail in: Paws::ImageBuilder::GetInfrastructureConfiguration

Returns: a Paws::ImageBuilder::GetInfrastructureConfigurationResponse instance

Gets an infrastructure configuration.

ImportComponent

ClientToken => Str
Format => Str
Name => Str
Platform => Str
SemanticVersion => Str
Type => Str
[ChangeDescription => Str]
[Data => Str]
[Description => Str]
[KmsKeyId => Str]
[Tags => Paws::ImageBuilder::TagMap]
[Uri => Str]

Each argument is described in detail in: Paws::ImageBuilder::ImportComponent

Returns: a Paws::ImageBuilder::ImportComponentResponse instance

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

ListComponentBuildVersions

ComponentVersionArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListComponentBuildVersions

Returns: a Paws::ImageBuilder::ListComponentBuildVersionsResponse instance

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

ListComponents

[ByName => Bool]
[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListComponents

Returns: a Paws::ImageBuilder::ListComponentsResponse instance

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

ListContainerRecipes

[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListContainerRecipes

Returns: a Paws::ImageBuilder::ListContainerRecipesResponse instance

Returns a list of container recipes.

ListDistributionConfigurations

[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListDistributionConfigurations

Returns: a Paws::ImageBuilder::ListDistributionConfigurationsResponse instance

Returns a list of distribution configurations.

ListImageBuildVersions

ImageVersionArn => Str
[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImageBuildVersions

Returns: a Paws::ImageBuilder::ListImageBuildVersionsResponse instance

Returns a list of image build versions.

ListImagePackages

ImageBuildVersionArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImagePackages

Returns: a Paws::ImageBuilder::ListImagePackagesResponse instance

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

ListImagePipelineImages

ImagePipelineArn => Str
[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImagePipelineImages

Returns: a Paws::ImageBuilder::ListImagePipelineImagesResponse instance

Returns a list of images created by the specified pipeline.

ListImagePipelines

[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImagePipelines

Returns: a Paws::ImageBuilder::ListImagePipelinesResponse instance

Returns a list of image pipelines.

ListImageRecipes

[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImageRecipes

Returns: a Paws::ImageBuilder::ListImageRecipesResponse instance

Returns a list of image recipes.

ListImages

[ByName => Bool]
[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[IncludeDeprecated => Bool]
[MaxResults => Int]
[NextToken => Str]
[Owner => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListImages

Returns: a Paws::ImageBuilder::ListImagesResponse instance

Returns the list of images that you have access to.

ListInfrastructureConfigurations

[Filters => ArrayRef[Paws::ImageBuilder::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ImageBuilder::ListInfrastructureConfigurations

Returns: a Paws::ImageBuilder::ListInfrastructureConfigurationsResponse instance

Returns a list of infrastructure configurations.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::ImageBuilder::ListTagsForResource

Returns: a Paws::ImageBuilder::ListTagsForResourceResponse instance

Returns the list of tags for the specified resource.

PutComponentPolicy

ComponentArn => Str
Policy => Str

Each argument is described in detail in: Paws::ImageBuilder::PutComponentPolicy

Returns: a Paws::ImageBuilder::PutComponentPolicyResponse instance

Applies 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 API PutComponentPolicy, 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.

PutContainerRecipePolicy

ContainerRecipeArn => Str
Policy => Str

Each argument is described in detail in: Paws::ImageBuilder::PutContainerRecipePolicy

Returns: a Paws::ImageBuilder::PutContainerRecipePolicyResponse instance

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.

PutImagePolicy

ImageArn => Str
Policy => Str

Each argument is described in detail in: Paws::ImageBuilder::PutImagePolicy

Returns: a Paws::ImageBuilder::PutImagePolicyResponse instance

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 API PutImagePolicy, 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.

PutImageRecipePolicy

ImageRecipeArn => Str
Policy => Str

Each argument is described in detail in: Paws::ImageBuilder::PutImageRecipePolicy

Returns: a Paws::ImageBuilder::PutImageRecipePolicyResponse instance

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 API PutImageRecipePolicy, 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.

StartImagePipelineExecution

ClientToken => Str
ImagePipelineArn => Str

Each argument is described in detail in: Paws::ImageBuilder::StartImagePipelineExecution

Returns: a Paws::ImageBuilder::StartImagePipelineExecutionResponse instance

Manually triggers a pipeline to create an image.

TagResource

ResourceArn => Str
Tags => Paws::ImageBuilder::TagMap

Each argument is described in detail in: Paws::ImageBuilder::TagResource

Returns: a Paws::ImageBuilder::TagResourceResponse instance

Adds a tag to a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ImageBuilder::UntagResource

Returns: a Paws::ImageBuilder::UntagResourceResponse instance

Removes a tag from a resource.

UpdateDistributionConfiguration

ClientToken => Str
DistributionConfigurationArn => Str
Distributions => ArrayRef[Paws::ImageBuilder::Distribution]
[Description => Str]

Each argument is described in detail in: Paws::ImageBuilder::UpdateDistributionConfiguration

Returns: a Paws::ImageBuilder::UpdateDistributionConfigurationResponse instance

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

UpdateImagePipeline

ClientToken => Str
ImagePipelineArn => Str
InfrastructureConfigurationArn => Str
[ContainerRecipeArn => Str]
[Description => Str]
[DistributionConfigurationArn => Str]
[EnhancedImageMetadataEnabled => Bool]
[ImageRecipeArn => Str]
[ImageTestsConfiguration => Paws::ImageBuilder::ImageTestsConfiguration]
[Schedule => Paws::ImageBuilder::Schedule]
[Status => Str]

Each argument is described in detail in: Paws::ImageBuilder::UpdateImagePipeline

Returns: a Paws::ImageBuilder::UpdateImagePipelineResponse instance

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.

UpdateInfrastructureConfiguration

ClientToken => Str
InfrastructureConfigurationArn => Str
InstanceProfileName => Str
[Description => Str]
[InstanceTypes => ArrayRef[Str|Undef]]
[KeyPair => Str]
[Logging => Paws::ImageBuilder::Logging]
[ResourceTags => Paws::ImageBuilder::ResourceTagMap]
[SecurityGroupIds => ArrayRef[Str|Undef]]
[SnsTopicArn => Str]
[SubnetId => Str]
[TerminateInstanceOnFailure => Bool]

Each argument is described in detail in: Paws::ImageBuilder::UpdateInfrastructureConfiguration

Returns: a Paws::ImageBuilder::UpdateInfrastructureConfigurationResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues