imagebuilder

package module
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 13, 2021 License: Apache-2.0 Imports: 28 Imported by: 10

Documentation

Overview

Package imagebuilder provides the API client, operations, and parameter types for EC2 Image Builder.

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.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-12-02"
View Source 
const ServiceID = "imagebuilder"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type CancelImageCreationInput 

type CancelImageCreationInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image whose creation you want to cancel.
	//
	// This member is required.
	ImageBuildVersionArn *string
}

type CancelImageCreationOutput 

type CancelImageCreationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for EC2 Image Builder.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelImageCreation 

func (c *Client) CancelImageCreation(ctx context.Context, params *CancelImageCreationInput, optFns ...func(*Options)) (*CancelImageCreationOutput, error)

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

func (*Client) CreateComponent 

func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error)

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

func (*Client) CreateContainerRecipe added in v0.31.0 

func (c *Client) CreateContainerRecipe(ctx context.Context, params *CreateContainerRecipeInput, optFns ...func(*Options)) (*CreateContainerRecipeOutput, error)

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

func (*Client) CreateDistributionConfiguration 

func (c *Client) CreateDistributionConfiguration(ctx context.Context, params *CreateDistributionConfigurationInput, optFns ...func(*Options)) (*CreateDistributionConfigurationOutput, error)

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

func (*Client) CreateImage 

func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error)

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.

func (*Client) CreateImagePipeline 

func (c *Client) CreateImagePipeline(ctx context.Context, params *CreateImagePipelineInput, optFns ...func(*Options)) (*CreateImagePipelineOutput, error)

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

func (*Client) CreateImageRecipe 

func (c *Client) CreateImageRecipe(ctx context.Context, params *CreateImageRecipeInput, optFns ...func(*Options)) (*CreateImageRecipeOutput, error)

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

func (*Client) CreateInfrastructureConfiguration 

func (c *Client) CreateInfrastructureConfiguration(ctx context.Context, params *CreateInfrastructureConfigurationInput, optFns ...func(*Options)) (*CreateInfrastructureConfigurationOutput, error)

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

func (*Client) DeleteComponent 

func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInput, optFns ...func(*Options)) (*DeleteComponentOutput, error)

Deletes a component build version.

func (*Client) DeleteContainerRecipe added in v0.31.0 

func (c *Client) DeleteContainerRecipe(ctx context.Context, params *DeleteContainerRecipeInput, optFns ...func(*Options)) (*DeleteContainerRecipeOutput, error)

Deletes a container recipe.

func (*Client) DeleteDistributionConfiguration 

func (c *Client) DeleteDistributionConfiguration(ctx context.Context, params *DeleteDistributionConfigurationInput, optFns ...func(*Options)) (*DeleteDistributionConfigurationOutput, error)

Deletes a distribution configuration.

func (*Client) DeleteImage 

func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error)

Deletes an image.

func (*Client) DeleteImagePipeline 

func (c *Client) DeleteImagePipeline(ctx context.Context, params *DeleteImagePipelineInput, optFns ...func(*Options)) (*DeleteImagePipelineOutput, error)

Deletes an image pipeline.

func (*Client) DeleteImageRecipe 

func (c *Client) DeleteImageRecipe(ctx context.Context, params *DeleteImageRecipeInput, optFns ...func(*Options)) (*DeleteImageRecipeOutput, error)

Deletes an image recipe.

func (*Client) DeleteInfrastructureConfiguration 

func (c *Client) DeleteInfrastructureConfiguration(ctx context.Context, params *DeleteInfrastructureConfigurationInput, optFns ...func(*Options)) (*DeleteInfrastructureConfigurationOutput, error)

Deletes an infrastructure configuration.

func (*Client) GetComponent 

func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error)

Gets a component object.

func (*Client) GetComponentPolicy 

func (c *Client) GetComponentPolicy(ctx context.Context, params *GetComponentPolicyInput, optFns ...func(*Options)) (*GetComponentPolicyOutput, error)

Gets a component policy.

func (*Client) GetContainerRecipe added in v0.31.0 

func (c *Client) GetContainerRecipe(ctx context.Context, params *GetContainerRecipeInput, optFns ...func(*Options)) (*GetContainerRecipeOutput, error)

Retrieves a container recipe.

func (*Client) GetContainerRecipePolicy added in v0.31.0 

func (c *Client) GetContainerRecipePolicy(ctx context.Context, params *GetContainerRecipePolicyInput, optFns ...func(*Options)) (*GetContainerRecipePolicyOutput, error)

Retrieves the policy for a container recipe.

func (*Client) GetDistributionConfiguration 

func (c *Client) GetDistributionConfiguration(ctx context.Context, params *GetDistributionConfigurationInput, optFns ...func(*Options)) (*GetDistributionConfigurationOutput, error)

Gets a distribution configuration.

func (*Client) GetImage 

func (c *Client) GetImage(ctx context.Context, params *GetImageInput, optFns ...func(*Options)) (*GetImageOutput, error)

Gets an image.

func (*Client) GetImagePipeline 

func (c *Client) GetImagePipeline(ctx context.Context, params *GetImagePipelineInput, optFns ...func(*Options)) (*GetImagePipelineOutput, error)

Gets an image pipeline.

func (*Client) GetImagePolicy 

func (c *Client) GetImagePolicy(ctx context.Context, params *GetImagePolicyInput, optFns ...func(*Options)) (*GetImagePolicyOutput, error)

Gets an image policy.

func (*Client) GetImageRecipe 

func (c *Client) GetImageRecipe(ctx context.Context, params *GetImageRecipeInput, optFns ...func(*Options)) (*GetImageRecipeOutput, error)

Gets an image recipe.

func (*Client) GetImageRecipePolicy 

func (c *Client) GetImageRecipePolicy(ctx context.Context, params *GetImageRecipePolicyInput, optFns ...func(*Options)) (*GetImageRecipePolicyOutput, error)

Gets an image recipe policy.

func (*Client) GetInfrastructureConfiguration 

func (c *Client) GetInfrastructureConfiguration(ctx context.Context, params *GetInfrastructureConfigurationInput, optFns ...func(*Options)) (*GetInfrastructureConfigurationOutput, error)

Gets an infrastructure configuration.

func (*Client) ImportComponent 

func (c *Client) ImportComponent(ctx context.Context, params *ImportComponentInput, optFns ...func(*Options)) (*ImportComponentOutput, error)

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

func (*Client) ListComponentBuildVersions 

func (c *Client) ListComponentBuildVersions(ctx context.Context, params *ListComponentBuildVersionsInput, optFns ...func(*Options)) (*ListComponentBuildVersionsOutput, error)

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

func (*Client) ListComponents 

func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error)

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

func (*Client) ListContainerRecipes added in v0.31.0 

func (c *Client) ListContainerRecipes(ctx context.Context, params *ListContainerRecipesInput, optFns ...func(*Options)) (*ListContainerRecipesOutput, error)

Returns a list of container recipes.

func (*Client) ListDistributionConfigurations 

func (c *Client) ListDistributionConfigurations(ctx context.Context, params *ListDistributionConfigurationsInput, optFns ...func(*Options)) (*ListDistributionConfigurationsOutput, error)

Returns a list of distribution configurations.

func (*Client) ListImageBuildVersions 

func (c *Client) ListImageBuildVersions(ctx context.Context, params *ListImageBuildVersionsInput, optFns ...func(*Options)) (*ListImageBuildVersionsOutput, error)

Returns a list of image build versions.

func (*Client) ListImagePipelineImages 

func (c *Client) ListImagePipelineImages(ctx context.Context, params *ListImagePipelineImagesInput, optFns ...func(*Options)) (*ListImagePipelineImagesOutput, error)

Returns a list of images created by the specified pipeline.

func (*Client) ListImagePipelines 

func (c *Client) ListImagePipelines(ctx context.Context, params *ListImagePipelinesInput, optFns ...func(*Options)) (*ListImagePipelinesOutput, error)

Returns a list of image pipelines.

func (*Client) ListImageRecipes 

func (c *Client) ListImageRecipes(ctx context.Context, params *ListImageRecipesInput, optFns ...func(*Options)) (*ListImageRecipesOutput, error)

Returns a list of image recipes.

func (*Client) ListImages 

func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns ...func(*Options)) (*ListImagesOutput, error)

Returns the list of images that you have access to.

func (*Client) ListInfrastructureConfigurations 

func (c *Client) ListInfrastructureConfigurations(ctx context.Context, params *ListInfrastructureConfigurationsInput, optFns ...func(*Options)) (*ListInfrastructureConfigurationsOutput, error)

Returns a list of infrastructure configurations.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns the list of tags for the specified resource.

func (*Client) PutComponentPolicy 

func (c *Client) PutComponentPolicy(ctx context.Context, params *PutComponentPolicyInput, optFns ...func(*Options)) (*PutComponentPolicyOutput, error)

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.

func (*Client) PutContainerRecipePolicy added in v0.31.0 

func (c *Client) PutContainerRecipePolicy(ctx context.Context, params *PutContainerRecipePolicyInput, optFns ...func(*Options)) (*PutContainerRecipePolicyOutput, error)

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.

func (*Client) PutImagePolicy 

func (c *Client) PutImagePolicy(ctx context.Context, params *PutImagePolicyInput, optFns ...func(*Options)) (*PutImagePolicyOutput, error)

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.

func (*Client) PutImageRecipePolicy 

func (c *Client) PutImageRecipePolicy(ctx context.Context, params *PutImageRecipePolicyInput, optFns ...func(*Options)) (*PutImageRecipePolicyOutput, error)

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.

func (*Client) StartImagePipelineExecution 

func (c *Client) StartImagePipelineExecution(ctx context.Context, params *StartImagePipelineExecutionInput, optFns ...func(*Options)) (*StartImagePipelineExecutionOutput, error)

Manually triggers a pipeline to create an image.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds a tag to a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag from a resource.

func (*Client) UpdateDistributionConfiguration 

func (c *Client) UpdateDistributionConfiguration(ctx context.Context, params *UpdateDistributionConfigurationInput, optFns ...func(*Options)) (*UpdateDistributionConfigurationOutput, error)

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

func (*Client) UpdateImagePipeline 

func (c *Client) UpdateImagePipeline(ctx context.Context, params *UpdateImagePipelineInput, optFns ...func(*Options)) (*UpdateImagePipelineOutput, error)

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

func (*Client) UpdateInfrastructureConfiguration 

func (c *Client) UpdateInfrastructureConfiguration(ctx context.Context, params *UpdateInfrastructureConfigurationInput, optFns ...func(*Options)) (*UpdateInfrastructureConfigurationOutput, error)

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

type CreateComponentInput 

type CreateComponentInput struct {

	// The idempotency token of the component.
	//
	// This member is required.
	ClientToken *string

	// The name of the component.
	//
	// This member is required.
	Name *string

	// The platform of the component.
	//
	// This member is required.
	Platform types.Platform

	// The semantic version of the component. This version follows the semantic version
	// syntax. For example, major.minor.patch. This could be versioned like software
	// (2.0.1) or like a date (2019.12.01).
	//
	// This member is required.
	SemanticVersion *string

	// The change description of the component. Describes what change has been made in
	// this version, or what makes this version different from other versions of this
	// component.
	ChangeDescription *string

	// The data of the component. Used to specify the data inline. Either data or uri
	// can be used to specify the data within the component.
	Data *string

	// The description of the component. Describes the contents of the component.
	Description *string

	// The ID of the KMS key that should be used to encrypt this component.
	KmsKeyId *string

	// The operating system (OS) version supported by the component. If the OS
	// information is available, a prefix match is performed against the parent image
	// OS version during image recipe creation.
	SupportedOsVersions []string

	// The tags of the component.
	Tags map[string]string

	// The uri of the component. Must be an S3 URL and the requester must have
	// permission to access the S3 bucket. If you use S3, you can specify component
	// content up to your service quota. Either data or uri can be used to specify the
	// data within the component.
	Uri *string
}

type CreateComponentOutput 

type CreateComponentOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the component that was created by this
	// request.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContainerRecipeInput added in v0.31.0 

type CreateContainerRecipeInput struct {

	// The client token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// Components for build and test that are included in the container recipe.
	//
	// This member is required.
	Components []types.ComponentConfiguration

	// The type of container to create.
	//
	// This member is required.
	ContainerType types.ContainerType

	// The Dockerfile template used to build your image as an inline data blob.
	//
	// This member is required.
	DockerfileTemplateData *string

	// The name of the container recipe.
	//
	// This member is required.
	Name *string

	// The source image for the container recipe.
	//
	// This member is required.
	ParentImage *string

	// The semantic version of the container recipe (<major>.<minor>.<patch>).
	//
	// This member is required.
	SemanticVersion *string

	// The destination repository for the container image.
	//
	// This member is required.
	TargetRepository *types.TargetContainerRepository

	// The description of the container recipe.
	Description *string

	// The S3 URI for the Dockerfile that will be used to build your container image.
	DockerfileTemplateUri *string

	// Specifies the operating system version for the source image.
	ImageOsVersionOverride *string

	// Identifies which KMS key is used to encrypt the container image.
	KmsKeyId *string

	// Specifies the operating system platform when you use a custom source image.
	PlatformOverride types.Platform

	// Tags that are attached to the container recipe.
	Tags map[string]string

	// The working directory for use during build and test workflows.
	WorkingDirectory *string
}

type CreateContainerRecipeOutput added in v0.31.0 

type CreateContainerRecipeOutput struct {

	// The client token used to make this request idempotent.
	ClientToken *string

	// Returns the Amazon Resource Name (ARN) of the container recipe that the request
	// created.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDistributionConfigurationInput 

type CreateDistributionConfigurationInput struct {

	// The idempotency token of the distribution configuration.
	//
	// This member is required.
	ClientToken *string

	// The distributions of the distribution configuration.
	//
	// This member is required.
	Distributions []types.Distribution

	// The name of the distribution configuration.
	//
	// This member is required.
	Name *string

	// The description of the distribution configuration.
	Description *string

	// The tags of the distribution configuration.
	Tags map[string]string
}

type CreateDistributionConfigurationOutput 

type CreateDistributionConfigurationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// created by this request.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateImageInput 

type CreateImageInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that defines
	// the environment in which your image will be built and tested.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The Amazon Resource Name (ARN) of the container recipe that defines how images
	// are configured and tested.
	ContainerRecipeArn *string

	// The Amazon Resource Name (ARN) of the distribution configuration that defines
	// and configures the outputs of your pipeline.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled bool

	// The Amazon Resource Name (ARN) of the image recipe that defines how images are
	// configured, tested, and assessed.
	ImageRecipeArn *string

	// The image tests configuration of the image.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The tags of the image.
	Tags map[string]string
}

type CreateImageOutput 

type CreateImageOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image that was created by this request.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateImagePipelineInput 

type CreateImagePipelineInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that will be
	// used to build images created by this image pipeline.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The name of the image pipeline.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the container recipe that is used to configure
	// images created by this container pipeline.
	ContainerRecipeArn *string

	// The description of the image pipeline.
	Description *string

	// The Amazon Resource Name (ARN) of the distribution configuration that will be
	// used to configure and distribute images created by this image pipeline.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled bool

	// The Amazon Resource Name (ARN) of the image recipe that will be used to
	// configure images created by this image pipeline.
	ImageRecipeArn *string

	// The image test configuration of the image pipeline.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The schedule of the image pipeline.
	Schedule *types.Schedule

	// The status of the image pipeline.
	Status types.PipelineStatus

	// The tags of the image pipeline.
	Tags map[string]string
}

type CreateImagePipelineOutput 

type CreateImagePipelineOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that was created by this
	// request.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateImageRecipeInput 

type CreateImageRecipeInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The components of the image recipe.
	//
	// This member is required.
	Components []types.ComponentConfiguration

	// The name of the image recipe.
	//
	// This member is required.
	Name *string

	// The parent image of the image recipe. The value of the string can be the ARN of
	// the parent image or an AMI ID. The format for the ARN follows this example:
	// arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x.
	// You can provide the specific version that you want to use, or you can use a
	// wildcard in all of the fields. If you enter an AMI ID for the string value, you
	// must have access to the AMI, and the AMI must be in the same Region in which you
	// are using Image Builder.
	//
	// This member is required.
	ParentImage *string

	// The semantic version of the image recipe.
	//
	// This member is required.
	SemanticVersion *string

	// The block device mappings of the image recipe.
	BlockDeviceMappings []types.InstanceBlockDeviceMapping

	// The description of the image recipe.
	Description *string

	// The tags of the image recipe.
	Tags map[string]string

	// The working directory to be used during build and test workflows.
	WorkingDirectory *string
}

type CreateImageRecipeOutput 

type CreateImageRecipeOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image recipe that was created by this
	// request.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateInfrastructureConfigurationInput 

type CreateInfrastructureConfigurationInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The instance profile to associate with the instance used to customize your EC2
	// AMI.
	//
	// This member is required.
	InstanceProfileName *string

	// The name of the infrastructure configuration.
	//
	// This member is required.
	Name *string

	// The description of the infrastructure configuration.
	Description *string

	// The instance types of the infrastructure configuration. You can specify one or
	// more instance types to use for this build. The service will pick one of these
	// instance types based on availability.
	InstanceTypes []string

	// The key pair of the infrastructure configuration. This can be used to log on to
	// and debug the instance used to create your image.
	KeyPair *string

	// The logging configuration of the infrastructure configuration.
	Logging *types.Logging

	// The tags attached to the resource created by Image Builder.
	ResourceTags map[string]string

	// The security group IDs to associate with the instance used to customize your EC2
	// AMI.
	SecurityGroupIds []string

	// The SNS topic on which to send image build events.
	SnsTopicArn *string

	// The subnet ID in which to place the instance used to customize your EC2 AMI.
	SubnetId *string

	// The tags of the infrastructure configuration.
	Tags map[string]string

	// The terminate instance on failure setting of the infrastructure configuration.
	// Set to false if you want Image Builder to retain the instance used to configure
	// your AMI if the build or test phase of your workflow fails.
	TerminateInstanceOnFailure bool
}

type CreateInfrastructureConfigurationOutput 

type CreateInfrastructureConfigurationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// created by this request.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteComponentInput 

type DeleteComponentInput struct {

	// The Amazon Resource Name (ARN) of the component build version to delete.
	//
	// This member is required.
	ComponentBuildVersionArn *string
}

type DeleteComponentOutput 

type DeleteComponentOutput struct {

	// The Amazon Resource Name (ARN) of the component build version that was deleted.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteContainerRecipeInput added in v0.31.0 

type DeleteContainerRecipeInput struct {

	// The Amazon Resource Name (ARN) of the container recipe to delete.
	//
	// This member is required.
	ContainerRecipeArn *string
}

type DeleteContainerRecipeOutput added in v0.31.0 

type DeleteContainerRecipeOutput struct {

	// The Amazon Resource Name (ARN) of the container recipe that was deleted.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDistributionConfigurationInput 

type DeleteDistributionConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration to delete.
	//
	// This member is required.
	DistributionConfigurationArn *string
}

type DeleteDistributionConfigurationOutput 

type DeleteDistributionConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// deleted.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteImageInput 

type DeleteImageInput struct {

	// The Amazon Resource Name (ARN) of the image to delete.
	//
	// This member is required.
	ImageBuildVersionArn *string
}

type DeleteImageOutput 

type DeleteImageOutput struct {

	// The Amazon Resource Name (ARN) of the image that was deleted.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteImagePipelineInput 

type DeleteImagePipelineInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline to delete.
	//
	// This member is required.
	ImagePipelineArn *string
}

type DeleteImagePipelineOutput 

type DeleteImagePipelineOutput struct {

	// The Amazon Resource Name (ARN) of the image pipeline that was deleted.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteImageRecipeInput 

type DeleteImageRecipeInput struct {

	// The Amazon Resource Name (ARN) of the image recipe to delete.
	//
	// This member is required.
	ImageRecipeArn *string
}

type DeleteImageRecipeOutput 

type DeleteImageRecipeOutput struct {

	// The Amazon Resource Name (ARN) of the image recipe that was deleted.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteInfrastructureConfigurationInput 

type DeleteInfrastructureConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
	//
	// This member is required.
	InfrastructureConfigurationArn *string
}

type DeleteInfrastructureConfigurationOutput 

type DeleteInfrastructureConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// deleted.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetComponentInput 

type GetComponentInput struct {

	// The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex
	// requires "/\d+$" suffix.
	//
	// This member is required.
	ComponentBuildVersionArn *string
}

type GetComponentOutput 

type GetComponentOutput struct {

	// The component object associated with the specified ARN.
	Component *types.Component

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetComponentPolicyInput 

type GetComponentPolicyInput struct {

	// The Amazon Resource Name (ARN) of the component whose policy you want to
	// retrieve.
	//
	// This member is required.
	ComponentArn *string
}

type GetComponentPolicyOutput 

type GetComponentPolicyOutput struct {

	// The component policy.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerRecipeInput added in v0.31.0 

type GetContainerRecipeInput struct {

	// The Amazon Resource Name (ARN) of the container recipe to retrieve.
	//
	// This member is required.
	ContainerRecipeArn *string
}

type GetContainerRecipeOutput added in v0.31.0 

type GetContainerRecipeOutput struct {

	// The container recipe object that is returned.
	ContainerRecipe *types.ContainerRecipe

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerRecipePolicyInput added in v0.31.0 

type GetContainerRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the container recipe for the policy being
	// requested.
	//
	// This member is required.
	ContainerRecipeArn *string
}

type GetContainerRecipePolicyOutput added in v0.31.0 

type GetContainerRecipePolicyOutput struct {

	// The container recipe policy object that is returned.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDistributionConfigurationInput 

type GetDistributionConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the distribution configuration that you want
	// to retrieve.
	//
	// This member is required.
	DistributionConfigurationArn *string
}

type GetDistributionConfigurationOutput 

type GetDistributionConfigurationOutput struct {

	// The distribution configuration object.
	DistributionConfiguration *types.DistributionConfiguration

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetImageInput 

type GetImageInput struct {

	// The Amazon Resource Name (ARN) of the image that you want to retrieve.
	//
	// This member is required.
	ImageBuildVersionArn *string
}

type GetImageOutput 

type GetImageOutput struct {

	// The image object.
	Image *types.Image

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetImagePipelineInput 

type GetImagePipelineInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
	//
	// This member is required.
	ImagePipelineArn *string
}

type GetImagePipelineOutput 

type GetImagePipelineOutput struct {

	// The image pipeline object.
	ImagePipeline *types.ImagePipeline

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetImagePolicyInput 

type GetImagePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
	//
	// This member is required.
	ImageArn *string
}

type GetImagePolicyOutput 

type GetImagePolicyOutput struct {

	// The image policy object.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetImageRecipeInput 

type GetImageRecipeInput struct {

	// The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
	//
	// This member is required.
	ImageRecipeArn *string
}

type GetImageRecipeOutput 

type GetImageRecipeOutput struct {

	// The image recipe object.
	ImageRecipe *types.ImageRecipe

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetImageRecipePolicyInput 

type GetImageRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image recipe whose policy you want to
	// retrieve.
	//
	// This member is required.
	ImageRecipeArn *string
}

type GetImageRecipePolicyOutput 

type GetImageRecipePolicyOutput struct {

	// The image recipe policy object.
	Policy *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInfrastructureConfigurationInput 

type GetInfrastructureConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration that you want
	// to retrieve.
	//
	// This member is required.
	InfrastructureConfigurationArn *string
}

GetInfrastructureConfiguration request object.

type GetInfrastructureConfigurationOutput 

type GetInfrastructureConfigurationOutput struct {

	// The infrastructure configuration object.
	InfrastructureConfiguration *types.InfrastructureConfiguration

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

GetInfrastructureConfiguration response object.

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportComponentInput 

type ImportComponentInput struct {

	// The idempotency token of the component.
	//
	// This member is required.
	ClientToken *string

	// The format of the resource that you want to import as a component.
	//
	// This member is required.
	Format types.ComponentFormat

	// The name of the component.
	//
	// This member is required.
	Name *string

	// The platform of the component.
	//
	// This member is required.
	Platform types.Platform

	// The semantic version of the component. This version follows the semantic version
	// syntax. For example, major.minor.patch. This could be versioned like software
	// (2.0.1) or like a date (2019.12.01).
	//
	// This member is required.
	SemanticVersion *string

	// The type of the component denotes whether the component is used to build the
	// image or only to test it.
	//
	// This member is required.
	Type types.ComponentType

	// The change description of the component. Describes what change has been made in
	// this version, or what makes this version different from other versions of this
	// component.
	ChangeDescription *string

	// The data of the component. Used to specify the data inline. Either data or uri
	// can be used to specify the data within the component.
	Data *string

	// The description of the component. Describes the contents of the component.
	Description *string

	// The ID of the KMS key that should be used to encrypt this component.
	KmsKeyId *string

	// The tags of the component.
	Tags map[string]string

	// The uri of the component. Must be an S3 URL and the requester must have
	// permission to access the S3 bucket. If you use S3, you can specify component
	// content up to your service quota. Either data or uri can be used to specify the
	// data within the component.
	Uri *string
}

type ImportComponentOutput 

type ImportComponentOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the imported component.
	ComponentBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListComponentBuildVersionsInput 

type ListComponentBuildVersionsInput struct {

	// The component version Amazon Resource Name (ARN) whose versions you want to
	// list.
	//
	// This member is required.
	ComponentVersionArn *string

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListComponentBuildVersionsOutput 

type ListComponentBuildVersionsOutput struct {

	// The list of component summaries for the specified semantic version.
	ComponentSummaryList []types.ComponentSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListComponentsInput 

type ListComponentsInput struct {

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

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string

	// The owner defines which components you want to list. By default, this request
	// will only show components owned by your account. You can use this field to
	// specify if you want to view components owned by yourself, by Amazon, or those
	// components that have been shared with you by other customers.
	Owner types.Ownership
}

type ListComponentsOutput 

type ListComponentsOutput struct {

	// The list of component semantic versions.
	ComponentVersionList []types.ComponentVersion

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListContainerRecipesInput added in v0.31.0 

type ListContainerRecipesInput struct {

	// Request filters that are used to narrow the list of container images that are
	// returned.
	Filters []types.Filter

	// The maximum number of results to return in the list.
	MaxResults int32

	// Provides a token for pagination, which determines where to begin the next set of
	// results when the current set reaches the maximum for one request.
	NextToken *string

	// Returns container recipes belonging to the specified owner, that have been
	// shared with you. You can omit this field to return container recipes belonging
	// to your account.
	Owner types.Ownership
}

type ListContainerRecipesOutput added in v0.31.0 

type ListContainerRecipesOutput struct {

	// The list of container recipes returned for the request.
	ContainerRecipeSummaryList []types.ContainerRecipeSummary

	// The next token field is used for paginated responses. When this is not empty,
	// there are additional container recipes that the service has not included in this
	// response. Use this token with the next request to retrieve additional list
	// items.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDistributionConfigurationsInput 

type ListDistributionConfigurationsInput struct {

	// The filters.
	//
	// * name - The name of this distribution configuration.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListDistributionConfigurationsOutput 

type ListDistributionConfigurationsOutput struct {

	// The list of distributions.
	DistributionConfigurationSummaryList []types.DistributionConfigurationSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImageBuildVersionsInput 

type ListImageBuildVersionsInput struct {

	// The Amazon Resource Name (ARN) of the image whose build versions you want to
	// retrieve.
	//
	// This member is required.
	ImageVersionArn *string

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListImageBuildVersionsOutput 

type ListImageBuildVersionsOutput struct {

	// The list of image build versions.
	ImageSummaryList []types.ImageSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImagePipelineImagesInput 

type ListImagePipelineImagesInput struct {

	// The Amazon Resource Name (ARN) of the image pipeline whose images you want to
	// view.
	//
	// This member is required.
	ImagePipelineArn *string

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListImagePipelineImagesOutput 

type ListImagePipelineImagesOutput struct {

	// The list of images built by this pipeline.
	ImageSummaryList []types.ImageSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImagePipelinesInput 

type ListImagePipelinesInput struct {

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListImagePipelinesOutput 

type ListImagePipelinesOutput struct {

	// The list of image pipelines.
	ImagePipelineList []types.ImagePipeline

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImageRecipesInput 

type ListImageRecipesInput struct {

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string

	// The owner defines which image recipes you want to list. By default, this request
	// will only show image recipes owned by your account. You can use this field to
	// specify if you want to view image recipes owned by yourself, by Amazon, or those
	// image recipes that have been shared with you by other customers.
	Owner types.Ownership
}

type ListImageRecipesOutput 

type ListImageRecipesOutput struct {

	// The list of image pipelines.
	ImageRecipeSummaryList []types.ImageRecipeSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImagesInput 

type ListImagesInput struct {

	// Requests a list of images with a specific recipe name.
	ByName bool

	// The filters.
	Filters []types.Filter

	// Includes deprecated images in the response list.
	IncludeDeprecated bool

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string

	// The owner defines which images you want to list. By default, this request will
	// only show images owned by your account. You can use this field to specify if you
	// want to view images owned by yourself, by Amazon, or those images that have been
	// shared with you by other customers.
	Owner types.Ownership
}

type ListImagesOutput 

type ListImagesOutput struct {

	// The list of image semantic versions.
	ImageVersionList []types.ImageVersion

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListInfrastructureConfigurationsInput 

type ListInfrastructureConfigurationsInput struct {

	// The filters.
	Filters []types.Filter

	// The maximum items to return in a request.
	MaxResults int32

	// A token to specify where to start paginating. This is the NextToken from a
	// previously truncated response.
	NextToken *string
}

type ListInfrastructureConfigurationsOutput 

type ListInfrastructureConfigurationsOutput struct {

	// The list of infrastructure configurations.
	InfrastructureConfigurationSummaryList []types.InfrastructureConfigurationSummary

	// The next token used for paginated responses. When this is not empty, there are
	// additional elements that the service has not included in this request. Use this
	// token with the next request to retrieve additional objects.
	NextToken *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the specified resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutComponentPolicyInput 

type PutComponentPolicyInput struct {

	// The Amazon Resource Name (ARN) of the component that this policy should be
	// applied to.
	//
	// This member is required.
	ComponentArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
}

type PutComponentPolicyOutput 

type PutComponentPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the component that this policy was applied to.
	ComponentArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutContainerRecipePolicyInput added in v0.31.0 

type PutContainerRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the container recipe that this policy should
	// be applied to.
	//
	// This member is required.
	ContainerRecipeArn *string

	// The policy to apply to the container recipe.
	//
	// This member is required.
	Policy *string
}

type PutContainerRecipePolicyOutput added in v0.31.0 

type PutContainerRecipePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the container recipe that this policy was
	// applied to.
	ContainerRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutImagePolicyInput 

type PutImagePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image that this policy should be applied
	// to.
	//
	// This member is required.
	ImageArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
}

type PutImagePolicyOutput 

type PutImagePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the image that this policy was applied to.
	ImageArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutImageRecipePolicyInput 

type PutImageRecipePolicyInput struct {

	// The Amazon Resource Name (ARN) of the image recipe that this policy should be
	// applied to.
	//
	// This member is required.
	ImageRecipeArn *string

	// The policy to apply.
	//
	// This member is required.
	Policy *string
}

type PutImageRecipePolicyOutput 

type PutImageRecipePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the image recipe that this policy was applied
	// to.
	ImageRecipeArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartImagePipelineExecutionInput 

type StartImagePipelineExecutionInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that you want to manually
	// invoke.
	//
	// This member is required.
	ImagePipelineArn *string
}

type StartImagePipelineExecutionOutput 

type StartImagePipelineExecutionOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image that was created by this request.
	ImageBuildVersionArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// The tags to apply to the resource.
	//
	// This member is required.
	Tags map[string]string
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDistributionConfigurationInput 

type UpdateDistributionConfigurationInput struct {

	// The idempotency token of the distribution configuration.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that you want
	// to update.
	//
	// This member is required.
	DistributionConfigurationArn *string

	// The distributions of the distribution configuration.
	//
	// This member is required.
	Distributions []types.Distribution

	// The description of the distribution configuration.
	Description *string
}

type UpdateDistributionConfigurationOutput 

type UpdateDistributionConfigurationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the distribution configuration that was
	// updated by this request.
	DistributionConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateImagePipelineInput 

type UpdateImagePipelineInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that you want to update.
	//
	// This member is required.
	ImagePipelineArn *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that will be
	// used to build images updated by this image pipeline.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The Amazon Resource Name (ARN) of the container pipeline to update.
	ContainerRecipeArn *string

	// The description of the image pipeline.
	Description *string

	// The Amazon Resource Name (ARN) of the distribution configuration that will be
	// used to configure and distribute images updated by this image pipeline.
	DistributionConfigurationArn *string

	// Collects additional information about the image being created, including the
	// operating system (OS) version and package list. This information is used to
	// enhance the overall experience of using EC2 Image Builder. Enabled by default.
	EnhancedImageMetadataEnabled bool

	// The Amazon Resource Name (ARN) of the image recipe that will be used to
	// configure images updated by this image pipeline.
	ImageRecipeArn *string

	// The image test configuration of the image pipeline.
	ImageTestsConfiguration *types.ImageTestsConfiguration

	// The schedule of the image pipeline.
	Schedule *types.Schedule

	// The status of the image pipeline.
	Status types.PipelineStatus
}

type UpdateImagePipelineOutput 

type UpdateImagePipelineOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the image pipeline that was updated by this
	// request.
	ImagePipelineArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateInfrastructureConfigurationInput 

type UpdateInfrastructureConfigurationInput struct {

	// The idempotency token used to make this request idempotent.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that you want
	// to update.
	//
	// This member is required.
	InfrastructureConfigurationArn *string

	// The instance profile to associate with the instance used to customize your EC2
	// AMI.
	//
	// This member is required.
	InstanceProfileName *string

	// The description of the infrastructure configuration.
	Description *string

	// The instance types of the infrastructure configuration. You can specify one or
	// more instance types to use for this build. The service will pick one of these
	// instance types based on availability.
	InstanceTypes []string

	// The key pair of the infrastructure configuration. This can be used to log on to
	// and debug the instance used to create your image.
	KeyPair *string

	// The logging configuration of the infrastructure configuration.
	Logging *types.Logging

	// The tags attached to the resource created by Image Builder.
	ResourceTags map[string]string

	// The security group IDs to associate with the instance used to customize your EC2
	// AMI.
	SecurityGroupIds []string

	// The SNS topic on which to send image build events.
	SnsTopicArn *string

	// The subnet ID to place the instance used to customize your EC2 AMI in.
	SubnetId *string

	// The terminate instance on failure setting of the infrastructure configuration.
	// Set to false if you want Image Builder to retain the instance used to configure
	// your AMI if the build or test phase of your workflow fails.
	TerminateInstanceOnFailure bool
}

type UpdateInfrastructureConfigurationOutput 

type UpdateInfrastructureConfigurationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the infrastructure configuration that was
	// updated by this request.
	InfrastructureConfigurationArn *string

	// The request ID that uniquely identifies this request.
	RequestId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.