Imagebuilder
public struct Imagebuilder
Client object for interacting with AWS Imagebuilder service.
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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Imagebuilder client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
Declaration
Swift
public func cancelImageCreation(_ input: CancelImageCreationRequest) -> EventLoopFuture<CancelImageCreationResponse>
-
Creates a new component that can be used to build, validate, test, and assess your image.
Declaration
Swift
public func createComponent(_ input: CreateComponentRequest) -> EventLoopFuture<CreateComponentResponse>
-
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
Declaration
Swift
public func createDistributionConfiguration(_ input: CreateDistributionConfigurationRequest) -> EventLoopFuture<CreateDistributionConfigurationResponse>
-
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
Declaration
Swift
public func createImage(_ input: CreateImageRequest) -> EventLoopFuture<CreateImageResponse>
-
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
Declaration
Swift
public func createImagePipeline(_ input: CreateImagePipelineRequest) -> EventLoopFuture<CreateImagePipelineResponse>
-
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
Declaration
Swift
public func createImageRecipe(_ input: CreateImageRecipeRequest) -> EventLoopFuture<CreateImageRecipeResponse>
-
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
Declaration
Swift
public func createInfrastructureConfiguration(_ input: CreateInfrastructureConfigurationRequest) -> EventLoopFuture<CreateInfrastructureConfigurationResponse>
-
Deletes a component build version.
Declaration
Swift
public func deleteComponent(_ input: DeleteComponentRequest) -> EventLoopFuture<DeleteComponentResponse>
-
Deletes a distribution configuration.
Declaration
Swift
public func deleteDistributionConfiguration(_ input: DeleteDistributionConfigurationRequest) -> EventLoopFuture<DeleteDistributionConfigurationResponse>
-
Deletes an image.
Declaration
Swift
public func deleteImage(_ input: DeleteImageRequest) -> EventLoopFuture<DeleteImageResponse>
-
Deletes an image pipeline.
Declaration
Swift
public func deleteImagePipeline(_ input: DeleteImagePipelineRequest) -> EventLoopFuture<DeleteImagePipelineResponse>
-
Deletes an image recipe.
Declaration
Swift
public func deleteImageRecipe(_ input: DeleteImageRecipeRequest) -> EventLoopFuture<DeleteImageRecipeResponse>
-
Deletes an infrastructure configuration.
Declaration
Swift
public func deleteInfrastructureConfiguration(_ input: DeleteInfrastructureConfigurationRequest) -> EventLoopFuture<DeleteInfrastructureConfigurationResponse>
-
Gets a component object.
Declaration
Swift
public func getComponent(_ input: GetComponentRequest) -> EventLoopFuture<GetComponentResponse>
-
Gets a component policy.
Declaration
Swift
public func getComponentPolicy(_ input: GetComponentPolicyRequest) -> EventLoopFuture<GetComponentPolicyResponse>
-
Gets a distribution configuration.
Declaration
Swift
public func getDistributionConfiguration(_ input: GetDistributionConfigurationRequest) -> EventLoopFuture<GetDistributionConfigurationResponse>
-
Gets an image.
Declaration
Swift
public func getImage(_ input: GetImageRequest) -> EventLoopFuture<GetImageResponse>
-
Gets an image pipeline.
Declaration
Swift
public func getImagePipeline(_ input: GetImagePipelineRequest) -> EventLoopFuture<GetImagePipelineResponse>
-
Gets an image policy.
Declaration
Swift
public func getImagePolicy(_ input: GetImagePolicyRequest) -> EventLoopFuture<GetImagePolicyResponse>
-
Gets an image recipe.
Declaration
Swift
public func getImageRecipe(_ input: GetImageRecipeRequest) -> EventLoopFuture<GetImageRecipeResponse>
-
Gets an image recipe policy.
Declaration
Swift
public func getImageRecipePolicy(_ input: GetImageRecipePolicyRequest) -> EventLoopFuture<GetImageRecipePolicyResponse>
-
Gets an infrastructure configuration.
Declaration
Swift
public func getInfrastructureConfiguration(_ input: GetInfrastructureConfigurationRequest) -> EventLoopFuture<GetInfrastructureConfigurationResponse>
-
Imports a component and transforms its data into a component document.
Declaration
Swift
public func importComponent(_ input: ImportComponentRequest) -> EventLoopFuture<ImportComponentResponse>
-
Returns the list of component build versions for the specified semantic version.
Declaration
Swift
public func listComponentBuildVersions(_ input: ListComponentBuildVersionsRequest) -> EventLoopFuture<ListComponentBuildVersionsResponse>
-
Returns the list of component build versions for the specified semantic version.
Declaration
Swift
public func listComponents(_ input: ListComponentsRequest) -> EventLoopFuture<ListComponentsResponse>
-
Returns a list of distribution configurations.
Declaration
Swift
public func listDistributionConfigurations(_ input: ListDistributionConfigurationsRequest) -> EventLoopFuture<ListDistributionConfigurationsResponse>
-
Returns a list of image build versions.
Declaration
Swift
public func listImageBuildVersions(_ input: ListImageBuildVersionsRequest) -> EventLoopFuture<ListImageBuildVersionsResponse>
-
Returns a list of images created by the specified pipeline.
Declaration
Swift
public func listImagePipelineImages(_ input: ListImagePipelineImagesRequest) -> EventLoopFuture<ListImagePipelineImagesResponse>
-
Returns a list of image pipelines.
Declaration
Swift
public func listImagePipelines(_ input: ListImagePipelinesRequest) -> EventLoopFuture<ListImagePipelinesResponse>
-
Returns a list of image recipes.
Declaration
Swift
public func listImageRecipes(_ input: ListImageRecipesRequest) -> EventLoopFuture<ListImageRecipesResponse>
-
Returns the list of images that you have access to.
Declaration
Swift
public func listImages(_ input: ListImagesRequest) -> EventLoopFuture<ListImagesResponse>
-
Returns a list of infrastructure configurations.
Declaration
Swift
public func listInfrastructureConfigurations(_ input: ListInfrastructureConfigurationsRequest) -> EventLoopFuture<ListInfrastructureConfigurationsResponse>
-
Returns the list of tags for the specified resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
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.
Declaration
Swift
public func putComponentPolicy(_ input: PutComponentPolicyRequest) -> EventLoopFuture<PutComponentPolicyResponse>
-
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.
Declaration
Swift
public func putImagePolicy(_ input: PutImagePolicyRequest) -> EventLoopFuture<PutImagePolicyResponse>
-
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.
Declaration
Swift
public func putImageRecipePolicy(_ input: PutImageRecipePolicyRequest) -> EventLoopFuture<PutImageRecipePolicyResponse>
-
Manually triggers a pipeline to create an image.
Declaration
Swift
public func startImagePipelineExecution(_ input: StartImagePipelineExecutionRequest) -> EventLoopFuture<StartImagePipelineExecutionResponse>
-
Adds a tag to a resource.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Removes a tag from a resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
Declaration
Swift
public func updateDistributionConfiguration(_ input: UpdateDistributionConfigurationRequest) -> EventLoopFuture<UpdateDistributionConfigurationResponse>
-
Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
Declaration
Swift
public func updateImagePipeline(_ input: UpdateImagePipelineRequest) -> EventLoopFuture<UpdateImagePipelineResponse>
-
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
Declaration
Swift
public func updateInfrastructureConfiguration(_ input: UpdateInfrastructureConfigurationRequest) -> EventLoopFuture<UpdateInfrastructureConfigurationResponse>
-
Returns the list of component build versions for the specified semantic version.
Declaration
Swift
public func listComponentBuildVersionsPaginator(_ input: ListComponentBuildVersionsRequest, onPage: @escaping (ListComponentBuildVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns the list of component build versions for the specified semantic version.
Declaration
Swift
public func listComponentsPaginator(_ input: ListComponentsRequest, onPage: @escaping (ListComponentsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of distribution configurations.
Declaration
Swift
public func listDistributionConfigurationsPaginator(_ input: ListDistributionConfigurationsRequest, onPage: @escaping (ListDistributionConfigurationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of image build versions.
Declaration
Swift
public func listImageBuildVersionsPaginator(_ input: ListImageBuildVersionsRequest, onPage: @escaping (ListImageBuildVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of images created by the specified pipeline.
Declaration
Swift
public func listImagePipelineImagesPaginator(_ input: ListImagePipelineImagesRequest, onPage: @escaping (ListImagePipelineImagesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of image pipelines.
Declaration
Swift
public func listImagePipelinesPaginator(_ input: ListImagePipelinesRequest, onPage: @escaping (ListImagePipelinesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of image recipes.
Declaration
Swift
public func listImageRecipesPaginator(_ input: ListImageRecipesRequest, onPage: @escaping (ListImageRecipesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns the list of images that you have access to.
Declaration
Swift
public func listImagesPaginator(_ input: ListImagesRequest, onPage: @escaping (ListImagesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of infrastructure configurations.
Declaration
Swift
public func listInfrastructureConfigurationsPaginator(_ input: ListInfrastructureConfigurationsRequest, onPage: @escaping (ListInfrastructureConfigurationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListComponentBuildVersionsRequest : AWSShape
extension Imagebuilder.ListComponentBuildVersionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListComponentsRequest : AWSShape
extension Imagebuilder.ListComponentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDistributionConfigurationsRequest : AWSShape
extension Imagebuilder.ListDistributionConfigurationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListImageBuildVersionsRequest : AWSShape
extension Imagebuilder.ListImageBuildVersionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListImagePipelineImagesRequest : AWSShape
extension Imagebuilder.ListImagePipelineImagesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListImagePipelinesRequest : AWSShape
extension Imagebuilder.ListImagePipelinesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListImageRecipesRequest : AWSShape
extension Imagebuilder.ListImageRecipesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListImagesRequest : AWSShape
extension Imagebuilder.ListImagesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListInfrastructureConfigurationsRequest : AWSShape
extension Imagebuilder.ListInfrastructureConfigurationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ComponentFormat : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ComponentType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum EbsVolumeType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImageStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Ownership : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PipelineExecutionStartCondition : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PipelineStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Platform : String, CustomStringConvertible, Codable