Imagebuilder class
EC2 Image Builder is a fully managed AWS 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.
Constructors
- Imagebuilder({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelImageCreation(
{required String imageBuildVersionArn, String? clientToken}) → Future< CancelImageCreationResponse> - CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createComponent(
{required String name, required Platform platform, required String semanticVersion, String? changeDescription, String? clientToken, String? data, String? description, String? kmsKeyId, List< String> ? supportedOsVersions, Map<String, String> ? tags, String? uri}) → Future<CreateComponentResponse> - Creates a new component that can be used to build, validate, test, and assess your image.
-
createContainerRecipe(
{required List< ComponentConfiguration> components, required ContainerType containerType, required String dockerfileTemplateData, required String name, required String parentImage, required String semanticVersion, required TargetContainerRepository targetRepository, String? clientToken, String? description, String? dockerfileTemplateUri, String? imageOsVersionOverride, String? kmsKeyId, Platform? platformOverride, Map<String, String> ? tags, String? workingDirectory}) → Future<CreateContainerRecipeResponse> - Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
-
createDistributionConfiguration(
{required List< Distribution> distributions, required String name, String? clientToken, String? description, Map<String, String> ? tags}) → Future<CreateDistributionConfigurationResponse> - Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
-
createImage(
{required String infrastructureConfigurationArn, String? clientToken, String? containerRecipeArn, String? distributionConfigurationArn, bool? enhancedImageMetadataEnabled, String? imageRecipeArn, ImageTestsConfiguration? imageTestsConfiguration, Map< String, String> ? tags}) → Future<CreateImageResponse> - Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
-
createImagePipeline(
{required String infrastructureConfigurationArn, required String name, String? clientToken, String? containerRecipeArn, String? description, String? distributionConfigurationArn, bool? enhancedImageMetadataEnabled, String? imageRecipeArn, ImageTestsConfiguration? imageTestsConfiguration, Schedule? schedule, PipelineStatus? status, Map< String, String> ? tags}) → Future<CreateImagePipelineResponse> - Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
-
createImageRecipe(
{required List< ComponentConfiguration> components, required String name, required String parentImage, required String semanticVersion, List<InstanceBlockDeviceMapping> ? blockDeviceMappings, String? clientToken, String? description, Map<String, String> ? tags, String? workingDirectory}) → Future<CreateImageRecipeResponse> - Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
-
createInfrastructureConfiguration(
{required String instanceProfileName, required String name, String? clientToken, String? description, List< String> ? instanceTypes, String? keyPair, Logging? logging, Map<String, String> ? resourceTags, List<String> ? securityGroupIds, String? snsTopicArn, String? subnetId, Map<String, String> ? tags, bool? terminateInstanceOnFailure}) → Future<CreateInfrastructureConfigurationResponse> - Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
-
deleteComponent(
{required String componentBuildVersionArn}) → Future< DeleteComponentResponse> - Deletes a component build version.
-
deleteContainerRecipe(
{required String containerRecipeArn}) → Future< DeleteContainerRecipeResponse> - Deletes a container recipe.
-
deleteDistributionConfiguration(
{required String distributionConfigurationArn}) → Future< DeleteDistributionConfigurationResponse> - Deletes a distribution configuration.
-
deleteImage(
{required String imageBuildVersionArn}) → Future< DeleteImageResponse> - Deletes an image.
-
deleteImagePipeline(
{required String imagePipelineArn}) → Future< DeleteImagePipelineResponse> - Deletes an image pipeline.
-
deleteImageRecipe(
{required String imageRecipeArn}) → Future< DeleteImageRecipeResponse> - Deletes an image recipe.
-
deleteInfrastructureConfiguration(
{required String infrastructureConfigurationArn}) → Future< DeleteInfrastructureConfigurationResponse> - Deletes an infrastructure configuration.
-
getComponent(
{required String componentBuildVersionArn}) → Future< GetComponentResponse> - Gets a component object.
-
getComponentPolicy(
{required String componentArn}) → Future< GetComponentPolicyResponse> - Gets a component policy.
-
getContainerRecipe(
{required String containerRecipeArn}) → Future< GetContainerRecipeResponse> - Retrieves a container recipe.
-
getContainerRecipePolicy(
{required String containerRecipeArn}) → Future< GetContainerRecipePolicyResponse> - Retrieves the policy for a container recipe.
-
getDistributionConfiguration(
{required String distributionConfigurationArn}) → Future< GetDistributionConfigurationResponse> - Gets a distribution configuration.
-
getImage(
{required String imageBuildVersionArn}) → Future< GetImageResponse> - Gets an image.
-
getImagePipeline(
{required String imagePipelineArn}) → Future< GetImagePipelineResponse> - Gets an image pipeline.
-
getImagePolicy(
{required String imageArn}) → Future< GetImagePolicyResponse> - Gets an image policy.
-
getImageRecipe(
{required String imageRecipeArn}) → Future< GetImageRecipeResponse> - Gets an image recipe.
-
getImageRecipePolicy(
{required String imageRecipeArn}) → Future< GetImageRecipePolicyResponse> - Gets an image recipe policy.
-
getInfrastructureConfiguration(
{required String infrastructureConfigurationArn}) → Future< GetInfrastructureConfigurationResponse> - Gets an infrastructure configuration.
-
importComponent(
{required ComponentFormat format, required String name, required Platform platform, required String semanticVersion, required ComponentType type, String? changeDescription, String? clientToken, String? data, String? description, String? kmsKeyId, Map< String, String> ? tags, String? uri}) → Future<ImportComponentResponse> - Imports a component and transforms its data into a component document.
-
listComponentBuildVersions(
{required String componentVersionArn, int? maxResults, String? nextToken}) → Future< ListComponentBuildVersionsResponse> - Returns the list of component build versions for the specified semantic version.
-
listComponents(
{bool? byName, List< Filter> ? filters, int? maxResults, String? nextToken, Ownership? owner}) → Future<ListComponentsResponse> - Returns the list of component build versions for the specified semantic version.
-
listContainerRecipes(
{List< Filter> ? filters, int? maxResults, String? nextToken, Ownership? owner}) → Future<ListContainerRecipesResponse> - Returns a list of container recipes.
-
listDistributionConfigurations(
{List< Filter> ? filters, int? maxResults, String? nextToken}) → Future<ListDistributionConfigurationsResponse> - Returns a list of distribution configurations.
-
listImageBuildVersions(
{required String imageVersionArn, List< Filter> ? filters, int? maxResults, String? nextToken}) → Future<ListImageBuildVersionsResponse> - Returns a list of image build versions.
-
listImagePipelineImages(
{required String imagePipelineArn, List< Filter> ? filters, int? maxResults, String? nextToken}) → Future<ListImagePipelineImagesResponse> - Returns a list of images created by the specified pipeline.
-
listImagePipelines(
{List< Filter> ? filters, int? maxResults, String? nextToken}) → Future<ListImagePipelinesResponse> - Returns a list of image pipelines.
-
listImageRecipes(
{List< Filter> ? filters, int? maxResults, String? nextToken, Ownership? owner}) → Future<ListImageRecipesResponse> - Returns a list of image recipes.
-
listImages(
{bool? byName, List< Filter> ? filters, bool? includeDeprecated, int? maxResults, String? nextToken, Ownership? owner}) → Future<ListImagesResponse> - Returns the list of images that you have access to.
-
listInfrastructureConfigurations(
{List< Filter> ? filters, int? maxResults, String? nextToken}) → Future<ListInfrastructureConfigurationsResponse> - Returns a list of infrastructure configurations.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Returns the list of tags for the specified resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putComponentPolicy(
{required String componentArn, required String policy}) → Future< PutComponentPolicyResponse> -
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. -
putContainerRecipePolicy(
{required String containerRecipeArn, required String policy}) → Future< PutContainerRecipePolicyResponse> -
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(
{required String imageArn, required String policy}) → Future< PutImagePolicyResponse> -
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. -
putImageRecipePolicy(
{required String imageRecipeArn, required String policy}) → Future< PutImageRecipePolicyResponse> -
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. -
startImagePipelineExecution(
{required String imagePipelineArn, String? clientToken}) → Future< StartImagePipelineExecutionResponse> - Manually triggers a pipeline to create an image.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Adds a tag to a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes a tag from a resource.
-
updateDistributionConfiguration(
{required String distributionConfigurationArn, required List< Distribution> distributions, String? clientToken, String? description}) → Future<UpdateDistributionConfigurationResponse> - Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
-
updateImagePipeline(
{required String imagePipelineArn, required String infrastructureConfigurationArn, String? clientToken, String? containerRecipeArn, String? description, String? distributionConfigurationArn, bool? enhancedImageMetadataEnabled, String? imageRecipeArn, ImageTestsConfiguration? imageTestsConfiguration, Schedule? schedule, PipelineStatus? status}) → Future< UpdateImagePipelineResponse> - Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
-
updateInfrastructureConfiguration(
{required String infrastructureConfigurationArn, required String instanceProfileName, String? clientToken, String? description, List< String> ? instanceTypes, String? keyPair, Logging? logging, Map<String, String> ? resourceTags, List<String> ? securityGroupIds, String? snsTopicArn, String? subnetId, bool? terminateInstanceOnFailure}) → Future<UpdateInfrastructureConfigurationResponse> - Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited