types

package
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: 2 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Ami 

type Ami struct {

	// The account ID of the owner of the AMI.
	AccountId *string

	// The description of the EC2 AMI. Minimum and maximum length are in characters.
	Description *string

	// The AMI ID of the EC2 AMI.
	Image *string

	// The name of the EC2 AMI.
	Name *string

	// The AWS Region of the EC2 AMI.
	Region *string

	// Image state shows the image status and the reason for that status.
	State *ImageState
}

Details of an EC2 AMI.

type AmiDistributionConfiguration 

type AmiDistributionConfiguration struct {

	// The tags to apply to AMIs distributed to this Region.
	AmiTags map[string]string

	// The description of the distribution configuration. Minimum and maximum length
	// are in characters.
	Description *string

	// The KMS key identifier used to encrypt the distributed image.
	KmsKeyId *string

	// Launch permissions can be used to configure which AWS accounts can use the AMI
	// to launch instances.
	LaunchPermission *LaunchPermissionConfiguration

	// The name of the distribution configuration.
	Name *string

	// The ID of an account to which you want to distribute an image.
	TargetAccountIds []string
}

Define and configure the output AMIs of the pipeline.

type CallRateLimitExceededException 

type CallRateLimitExceededException struct {
	Message *string
}

You have exceeded the permitted request rate for the specific operation.

func (*CallRateLimitExceededException) Error 

func (e *CallRateLimitExceededException) Error() string

func (*CallRateLimitExceededException) ErrorCode 

func (e *CallRateLimitExceededException) ErrorCode() string

func (*CallRateLimitExceededException) ErrorFault 

func (e *CallRateLimitExceededException) ErrorFault() smithy.ErrorFault

func (*CallRateLimitExceededException) ErrorMessage 

func (e *CallRateLimitExceededException) ErrorMessage() string

type ClientException 

type ClientException struct {
	Message *string
}

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

func (*ClientException) Error 

func (e *ClientException) Error() string

func (*ClientException) ErrorCode 

func (e *ClientException) ErrorCode() string

func (*ClientException) ErrorFault 

func (e *ClientException) ErrorFault() smithy.ErrorFault

func (*ClientException) ErrorMessage 

func (e *ClientException) ErrorMessage() string

type Component 

type Component struct {

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

	// The change description of the component.
	ChangeDescription *string

	// The data of the component.
	Data *string

	// The date that the component was created.
	DateCreated *string

	// The description of the component.
	Description *string

	// The encryption status of the component.
	Encrypted bool

	// The KMS key identifier used to encrypt the component.
	KmsKeyId *string

	// The name of the component.
	Name *string

	// The owner of the component.
	Owner *string

	// The platform of the component.
	Platform Platform

	// 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 associated with the component.
	Tags map[string]string

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

	// The version of the component.
	Version *string
}

A detailed view of a component.

type ComponentConfiguration 

type ComponentConfiguration struct {

	// The Amazon Resource Name (ARN) of the component.
	//
	// This member is required.
	ComponentArn *string
}

Configuration details of the component.

type ComponentFormat 

type ComponentFormat string
const (
	ComponentFormatShell ComponentFormat = "SHELL"
)

Enum values for ComponentFormat

func (ComponentFormat) Values added in v0.29.0 

func (ComponentFormat) Values() []ComponentFormat

Values returns all known values for ComponentFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ComponentSummary 

type ComponentSummary struct {

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

	// The change description of the component.
	ChangeDescription *string

	// The date that the component was created.
	DateCreated *string

	// The description of the component.
	Description *string

	// The name of the component.
	Name *string

	// The owner of the component.
	Owner *string

	// The platform of the component.
	Platform Platform

	// 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 associated with the component.
	Tags map[string]string

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

	// The version of the component.
	Version *string
}

A high-level summary of a component.

type ComponentType 

type ComponentType string
const (
	ComponentTypeBuild ComponentType = "BUILD"
	ComponentTypeTest  ComponentType = "TEST"
)

Enum values for ComponentType

func (ComponentType) Values added in v0.29.0 

func (ComponentType) Values() []ComponentType

Values returns all known values for ComponentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ComponentVersion 

type ComponentVersion struct {

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

	// The date that the component was created.
	DateCreated *string

	// The description of the component.
	Description *string

	// The name of the component.
	Name *string

	// The owner of the component.
	Owner *string

	// The platform of the component.
	Platform Platform

	// 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 type of the component denotes whether the component is used to build the
	// image or only to test it.
	Type ComponentType

	// The semantic version of the component.
	Version *string
}

A high-level overview of a component semantic version.

type Container added in v0.31.0 

type Container struct {

	// A list of URIs for containers created in the context Region.
	ImageUris []string

	// Containers and container images are Region-specific. This is the Region context
	// for the container.
	Region *string
}

A container encapsulates the runtime environment for an application.

type ContainerDistributionConfiguration added in v0.31.0 

type ContainerDistributionConfiguration struct {

	// The destination repository for the container distribution configuration.
	//
	// This member is required.
	TargetRepository *TargetContainerRepository

	// Tags that are attached to the container distribution configuration.
	ContainerTags []string

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

Container distribution settings for encryption, licensing, and sharing in a specific Region.

type ContainerRecipe added in v0.31.0 

type ContainerRecipe struct {

	// The Amazon Resource Name (ARN) of the container recipe.
	Arn *string

	// Components for build and test that are included in the container recipe.
	Components []ComponentConfiguration

	// Specifies the type of container, such as Docker.
	ContainerType ContainerType

	// The date when this container recipe was created.
	DateCreated *string

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

	// Dockerfiles are text documents that are used to build Docker containers, and
	// ensure that they contain all of the elements required by the application running
	// inside. The template data consists of contextual variables where Image Builder
	// places build information or scripts, based on your container image recipe.
	DockerfileTemplateData *string

	// A flag that indicates if the target container is encrypted.
	Encrypted bool

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

	// The name of the container recipe.
	Name *string

	// The owner of the container recipe.
	Owner *string

	// The source image for the container recipe.
	ParentImage *string

	// The system platform for the container, such as Windows or Linux.
	Platform Platform

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

	// The destination repository for the container image.
	TargetRepository *TargetContainerRepository

	// The semantic version of the container recipe (<major>.<minor>.<patch>).
	Version *string

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

A container recipe.

type ContainerRecipeSummary added in v0.31.0 

type ContainerRecipeSummary struct {

	// The Amazon Resource Name (ARN) of the container recipe.
	Arn *string

	// Specifies the type of container, such as "Docker".
	ContainerType ContainerType

	// The date when this container recipe was created.
	DateCreated *string

	// The name of the container recipe.
	Name *string

	// The owner of the container recipe.
	Owner *string

	// The source image for the container recipe.
	ParentImage *string

	// The system platform for the container, such as Windows or Linux.
	Platform Platform

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

A summary of a container recipe

type ContainerRepositoryService added in v0.31.0 

type ContainerRepositoryService string
const (
	ContainerRepositoryServiceEcr ContainerRepositoryService = "ECR"
)

Enum values for ContainerRepositoryService

func (ContainerRepositoryService) Values added in v0.31.0 

func (ContainerRepositoryService) Values() []ContainerRepositoryService

Values returns all known values for ContainerRepositoryService. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ContainerType added in v0.31.0 

type ContainerType string
const (
	ContainerTypeDocker ContainerType = "DOCKER"
)

Enum values for ContainerType

func (ContainerType) Values added in v0.31.0 

func (ContainerType) Values() []ContainerType

Values returns all known values for ContainerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Distribution 

type Distribution struct {

	// The target Region.
	//
	// This member is required.
	Region *string

	// The specific AMI settings (for example, launch permissions, AMI tags).
	AmiDistributionConfiguration *AmiDistributionConfiguration

	// Container distribution settings for encryption, licensing, and sharing in a
	// specific Region.
	ContainerDistributionConfiguration *ContainerDistributionConfiguration

	// The License Manager Configuration to associate with the AMI in the specified
	// Region.
	LicenseConfigurationArns []string
}

Defines the settings for a specific Region.

type DistributionConfiguration 

type DistributionConfiguration struct {

	// The maximum duration in minutes for this distribution configuration.
	//
	// This member is required.
	TimeoutMinutes int32

	// The Amazon Resource Name (ARN) of the distribution configuration.
	Arn *string

	// The date on which this distribution configuration was created.
	DateCreated *string

	// The date on which this distribution configuration was last updated.
	DateUpdated *string

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

	// The distributions of the distribution configuration.
	Distributions []Distribution

	// The name of the distribution configuration.
	Name *string

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

A distribution configuration.

type DistributionConfigurationSummary 

type DistributionConfigurationSummary struct {

	// The Amazon Resource Name (ARN) of the distribution configuration.
	Arn *string

	// The date on which the distribution configuration was created.
	DateCreated *string

	// The date on which the distribution configuration was updated.
	DateUpdated *string

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

	// The name of the distribution configuration.
	Name *string

	// A list of Regions where the container image is distributed to.
	Regions []string

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

A high-level overview of a distribution configuration.

type EbsInstanceBlockDeviceSpecification 

type EbsInstanceBlockDeviceSpecification struct {

	// Use to configure delete on termination of the associated device.
	DeleteOnTermination bool

	// Use to configure device encryption.
	Encrypted bool

	// Use to configure device IOPS.
	Iops int32

	// Use to configure the KMS key to use when encrypting the device.
	KmsKeyId *string

	// The snapshot that defines the device contents.
	SnapshotId *string

	// Use to override the device's volume size.
	VolumeSize int32

	// Use to override the device's volume type.
	VolumeType EbsVolumeType
}

Amazon EBS-specific block device mapping specifications.

type EbsVolumeType 

type EbsVolumeType string
const (
	EbsVolumeTypeStandard EbsVolumeType = "standard"
	EbsVolumeTypeIo1      EbsVolumeType = "io1"
	EbsVolumeTypeIo2      EbsVolumeType = "io2"
	EbsVolumeTypeGp2      EbsVolumeType = "gp2"
	EbsVolumeTypeSc1      EbsVolumeType = "sc1"
	EbsVolumeTypeSt1      EbsVolumeType = "st1"
)

Enum values for EbsVolumeType

func (EbsVolumeType) Values added in v0.29.0 

func (EbsVolumeType) Values() []EbsVolumeType

Values returns all known values for EbsVolumeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Filter 

type Filter struct {

	// The name of the filter. Filter names are case-sensitive.
	Name *string

	// The filter values. Filter values are case-sensitive.
	Values []string
}

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

type ForbiddenException 

type ForbiddenException struct {
	Message *string
}

You are not authorized to perform the requested operation.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

type IdempotentParameterMismatchException 

type IdempotentParameterMismatchException struct {
	Message *string
}

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

func (*IdempotentParameterMismatchException) Error 

func (e *IdempotentParameterMismatchException) Error() string

func (*IdempotentParameterMismatchException) ErrorCode 

func (e *IdempotentParameterMismatchException) ErrorCode() string

func (*IdempotentParameterMismatchException) ErrorFault 

func (e *IdempotentParameterMismatchException) ErrorFault() smithy.ErrorFault

func (*IdempotentParameterMismatchException) ErrorMessage 

func (e *IdempotentParameterMismatchException) ErrorMessage() string

type Image 

type Image struct {

	// The Amazon Resource Name (ARN) of the image.
	Arn *string

	// The container recipe used to create the container image type.
	ContainerRecipe *ContainerRecipe

	// The date on which this image was created.
	DateCreated *string

	// The distribution configuration used when creating this image.
	DistributionConfiguration *DistributionConfiguration

	// 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 image recipe used when creating the image.
	ImageRecipe *ImageRecipe

	// The image tests configuration used when creating this image.
	ImageTestsConfiguration *ImageTestsConfiguration

	// The infrastructure used when creating this image.
	InfrastructureConfiguration *InfrastructureConfiguration

	// The name of the image.
	Name *string

	// The operating system version of the instance. For example, Amazon Linux 2,
	// Ubuntu 18, or Microsoft Windows Server 2019.
	OsVersion *string

	// The output resources produced when creating this image.
	OutputResources *OutputResources

	// The platform of the image.
	Platform Platform

	// The Amazon Resource Name (ARN) of the image pipeline that created this image.
	SourcePipelineArn *string

	// The name of the image pipeline that created this image.
	SourcePipelineName *string

	// The state of the image.
	State *ImageState

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

	// Specifies whether this is an AMI or container image.
	Type ImageType

	// The semantic version of the image.
	Version *string
}

An image build version.

type ImagePipeline 

type ImagePipeline struct {

	// The Amazon Resource Name (ARN) of the image pipeline.
	Arn *string

	// The Amazon Resource Name (ARN) of the container recipe that is used for this
	// pipeline.
	ContainerRecipeArn *string

	// The date on which this image pipeline was created.
	DateCreated *string

	// The date on which this image pipeline was last run.
	DateLastRun *string

	// The date on which this image pipeline will next be run.
	DateNextRun *string

	// The date on which this image pipeline was last updated.
	DateUpdated *string

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

	// The Amazon Resource Name (ARN) of the distribution configuration associated with
	// 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 associated with this image
	// pipeline.
	ImageRecipeArn *string

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

	// The Amazon Resource Name (ARN) of the infrastructure configuration associated
	// with this image pipeline.
	InfrastructureConfigurationArn *string

	// The name of the image pipeline.
	Name *string

	// The platform of the image pipeline.
	Platform Platform

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

	// The status of the image pipeline.
	Status PipelineStatus

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

Details of an image pipeline.

type ImageRecipe 

type ImageRecipe struct {

	// The Amazon Resource Name (ARN) of the image recipe.
	Arn *string

	// The block device mappings to apply when creating images from this recipe.
	BlockDeviceMappings []InstanceBlockDeviceMapping

	// The components of the image recipe.
	Components []ComponentConfiguration

	// The date on which this image recipe was created.
	DateCreated *string

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

	// The name of the image recipe.
	Name *string

	// The owner of the image recipe.
	Owner *string

	// The parent image of the image recipe.
	ParentImage *string

	// The platform of the image recipe.
	Platform Platform

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

	// Specifies which type of image is created by the recipe - an AMI or a container
	// image.
	Type ImageType

	// The version of the image recipe.
	Version *string

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

An image recipe.

type ImageRecipeSummary 

type ImageRecipeSummary struct {

	// The Amazon Resource Name (ARN) of the image recipe.
	Arn *string

	// The date on which this image recipe was created.
	DateCreated *string

	// The name of the image recipe.
	Name *string

	// The owner of the image recipe.
	Owner *string

	// The parent image of the image recipe.
	ParentImage *string

	// The platform of the image recipe.
	Platform Platform

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

A summary of an image recipe.

type ImageState 

type ImageState struct {

	// The reason for the image's status.
	Reason *string

	// The status of the image.
	Status ImageStatus
}

Image state shows the image status and the reason for that status.

type ImageStatus 

type ImageStatus string
const (
	ImageStatusPending      ImageStatus = "PENDING"
	ImageStatusCreating     ImageStatus = "CREATING"
	ImageStatusBuilding     ImageStatus = "BUILDING"
	ImageStatusTesting      ImageStatus = "TESTING"
	ImageStatusDistributing ImageStatus = "DISTRIBUTING"
	ImageStatusIntegrating  ImageStatus = "INTEGRATING"
	ImageStatusAvailable    ImageStatus = "AVAILABLE"
	ImageStatusCancelled    ImageStatus = "CANCELLED"
	ImageStatusFailed       ImageStatus = "FAILED"
	ImageStatusDeprecated   ImageStatus = "DEPRECATED"
	ImageStatusDeleted      ImageStatus = "DELETED"
)

Enum values for ImageStatus

func (ImageStatus) Values added in v0.29.0 

func (ImageStatus) Values() []ImageStatus

Values returns all known values for ImageStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImageSummary 

type ImageSummary struct {

	// The Amazon Resource Name (ARN) of the image.
	Arn *string

	// The date on which this image was created.
	DateCreated *string

	// The name of the image.
	Name *string

	// The operating system version of the instance. For example, Amazon Linux 2,
	// Ubuntu 18, or Microsoft Windows Server 2019.
	OsVersion *string

	// The output resources produced when creating this image.
	OutputResources *OutputResources

	// The owner of the image.
	Owner *string

	// The platform of the image.
	Platform Platform

	// The state of the image.
	State *ImageState

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

	// Specifies whether this is an AMI or container image.
	Type ImageType

	// The version of the image.
	Version *string
}

An image summary.

type ImageTestsConfiguration 

type ImageTestsConfiguration struct {

	// Defines if tests should be executed when building this image.
	ImageTestsEnabled bool

	// The maximum time in minutes that tests are permitted to run.
	TimeoutMinutes int32
}

Image tests configuration.

type ImageType added in v0.31.0 

type ImageType string
const (
	ImageTypeAmi    ImageType = "AMI"
	ImageTypeDocker ImageType = "DOCKER"
)

Enum values for ImageType

func (ImageType) Values added in v0.31.0 

func (ImageType) Values() []ImageType

Values returns all known values for ImageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImageVersion 

type ImageVersion struct {

	// The Amazon Resource Name (ARN) of the image semantic version.
	Arn *string

	// The date at which this image semantic version was created.
	DateCreated *string

	// The name of the image semantic version.
	Name *string

	// The operating system version of the instance. For example, Amazon Linux 2,
	// Ubuntu 18, or Microsoft Windows Server 2019.
	OsVersion *string

	// The owner of the image semantic version.
	Owner *string

	// The platform of the image semantic version.
	Platform Platform

	// Specifies whether this is an AMI or container image.
	Type ImageType

	// The semantic version of the image semantic version.
	Version *string
}

An image semantic version.

type InfrastructureConfiguration 

type InfrastructureConfiguration struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration.
	Arn *string

	// The date on which the infrastructure configuration was created.
	DateCreated *string

	// The date on which the infrastructure configuration was last updated.
	DateUpdated *string

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

	// The instance profile of the infrastructure configuration.
	InstanceProfileName *string

	// The instance types of the infrastructure configuration.
	InstanceTypes []string

	// The EC2 key pair of the infrastructure configuration.
	KeyPair *string

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

	// The name of the infrastructure configuration.
	Name *string

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

	// The security group IDs of the infrastructure configuration.
	SecurityGroupIds []string

	// The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
	SnsTopicArn *string

	// The subnet ID of the infrastructure configuration.
	SubnetId *string

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

	// The terminate instance on failure configuration of the infrastructure
	// configuration.
	TerminateInstanceOnFailure bool
}

Details of the infrastructure configuration.

type InfrastructureConfigurationSummary 

type InfrastructureConfigurationSummary struct {

	// The Amazon Resource Name (ARN) of the infrastructure configuration.
	Arn *string

	// The date on which the infrastructure configuration was created.
	DateCreated *string

	// The date on which the infrastructure configuration was last updated.
	DateUpdated *string

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

	// The name of the infrastructure configuration.
	Name *string

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

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

The infrastructure used when building EC2 AMIs.

type InstanceBlockDeviceMapping 

type InstanceBlockDeviceMapping struct {

	// The device to which these mappings apply.
	DeviceName *string

	// Use to manage Amazon EBS-specific configuration for this mapping.
	Ebs *EbsInstanceBlockDeviceSpecification

	// Use to remove a mapping from the parent image.
	NoDevice *string

	// Use to manage instance ephemeral devices.
	VirtualName *string
}

Defines block device mappings for the instance used to configure your image.

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *string
}

You have provided an invalid pagination token in your request.

func (*InvalidPaginationTokenException) Error 

func (e *InvalidPaginationTokenException) Error() string

func (*InvalidPaginationTokenException) ErrorCode 

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault 

func (e *InvalidPaginationTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidPaginationTokenException) ErrorMessage 

func (e *InvalidPaginationTokenException) ErrorMessage() string

type InvalidParameterCombinationException 

type InvalidParameterCombinationException struct {
	Message *string
}

You have specified two or more mutually exclusive parameters. Review the error message for details.

func (*InvalidParameterCombinationException) Error 

func (e *InvalidParameterCombinationException) Error() string

func (*InvalidParameterCombinationException) ErrorCode 

func (e *InvalidParameterCombinationException) ErrorCode() string

func (*InvalidParameterCombinationException) ErrorFault 

func (e *InvalidParameterCombinationException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterCombinationException) ErrorMessage 

func (e *InvalidParameterCombinationException) ErrorMessage() string

type InvalidParameterException 

type InvalidParameterException struct {
	Message *string
}

The specified parameter is invalid. Review the available parameters for the API request.

func (*InvalidParameterException) Error 

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode 

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault 

func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterException) ErrorMessage 

func (e *InvalidParameterException) ErrorMessage() string

type InvalidParameterValueException 

type InvalidParameterValueException struct {
	Message *string
}

The value that you provided for the specified parameter is invalid.

func (*InvalidParameterValueException) Error 

func (e *InvalidParameterValueException) Error() string

func (*InvalidParameterValueException) ErrorCode 

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault 

func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterValueException) ErrorMessage 

func (e *InvalidParameterValueException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string
}

You have made a request for an action that is not supported by the service.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type InvalidVersionNumberException 

type InvalidVersionNumberException struct {
	Message *string
}

Your version number is out of bounds or does not follow the required syntax.

func (*InvalidVersionNumberException) Error 

func (e *InvalidVersionNumberException) Error() string

func (*InvalidVersionNumberException) ErrorCode 

func (e *InvalidVersionNumberException) ErrorCode() string

func (*InvalidVersionNumberException) ErrorFault 

func (e *InvalidVersionNumberException) ErrorFault() smithy.ErrorFault

func (*InvalidVersionNumberException) ErrorMessage 

func (e *InvalidVersionNumberException) ErrorMessage() string

type LaunchPermissionConfiguration 

type LaunchPermissionConfiguration struct {

	// The name of the group.
	UserGroups []string

	// The AWS account ID.
	UserIds []string
}

Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html).

type Logging 

type Logging struct {

	// The Amazon S3 logging configuration.
	S3Logs *S3Logs
}

Logging configuration defines where Image Builder uploads your logs.

type OutputResources 

type OutputResources struct {

	// The EC2 AMIs created by this image.
	Amis []Ami

	// Container images that the pipeline has generated and stored in the output
	// repository.
	Containers []Container
}

The resources produced by this image.

type Ownership 

type Ownership string
const (
	OwnershipSelf   Ownership = "Self"
	OwnershipShared Ownership = "Shared"
	OwnershipAmazon Ownership = "Amazon"
)

Enum values for Ownership

func (Ownership) Values added in v0.29.0 

func (Ownership) Values() []Ownership

Values returns all known values for Ownership. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PipelineExecutionStartCondition 

type PipelineExecutionStartCondition string
const (
	PipelineExecutionStartConditionExpressionMatchOnly                          PipelineExecutionStartCondition = "EXPRESSION_MATCH_ONLY"
	PipelineExecutionStartConditionExpressionMatchAndDependencyUpdatesAvailable PipelineExecutionStartCondition = "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
)

Enum values for PipelineExecutionStartCondition

func (PipelineExecutionStartCondition) Values added in v0.29.0 

func (PipelineExecutionStartCondition) Values() []PipelineExecutionStartCondition

Values returns all known values for PipelineExecutionStartCondition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PipelineStatus 

type PipelineStatus string
const (
	PipelineStatusDisabled PipelineStatus = "DISABLED"
	PipelineStatusEnabled  PipelineStatus = "ENABLED"
)

Enum values for PipelineStatus

func (PipelineStatus) Values added in v0.29.0 

func (PipelineStatus) Values() []PipelineStatus

Values returns all known values for PipelineStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Platform 

type Platform string
const (
	PlatformWindows Platform = "Windows"
	PlatformLinux   Platform = "Linux"
)

Enum values for Platform

func (Platform) Values added in v0.29.0 

func (Platform) Values() []Platform

Values returns all known values for Platform. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string
}

The resource that you are trying to create already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceDependencyException 

type ResourceDependencyException struct {
	Message *string
}

You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

func (*ResourceDependencyException) Error 

func (e *ResourceDependencyException) Error() string

func (*ResourceDependencyException) ErrorCode 

func (e *ResourceDependencyException) ErrorCode() string

func (*ResourceDependencyException) ErrorFault 

func (e *ResourceDependencyException) ErrorFault() smithy.ErrorFault

func (*ResourceDependencyException) ErrorMessage 

func (e *ResourceDependencyException) ErrorMessage() string

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string
}

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

At least one of the resources referenced by your request does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3Logs 

type S3Logs struct {

	// The Amazon S3 bucket in which to store the logs.
	S3BucketName *string

	// The Amazon S3 path in which to store the logs.
	S3KeyPrefix *string
}

Amazon S3 logging configuration.

type Schedule 

type Schedule struct {

	// The condition configures when the pipeline should trigger a new image build.
	// When the pipelineExecutionStartCondition is set to
	// EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version
	// filters on the source image or components in your image recipe, EC2 Image
	// Builder will build a new image only when there are new versions of the image or
	// components in your recipe that match the semantic version filter. When it is set
	// to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON
	// expression matches the current time. For semantic version syntax, see
	// CreateComponent
	// (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html)
	// in the EC2 Image Builder API Reference.
	PipelineExecutionStartCondition PipelineExecutionStartCondition

	// The cron expression determines how often EC2 Image Builder evaluates your
	// pipelineExecutionStartCondition. For information on how to format a cron
	// expression in Image Builder, see Use cron expressions in EC2 Image Builder
	// (https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html).
	ScheduleExpression *string
}

A schedule configures how often and when a pipeline will automatically create a new image.

type ServiceException 

type ServiceException struct {
	Message *string
}

This exception is thrown when the service encounters an unrecoverable exception.

func (*ServiceException) Error 

func (e *ServiceException) Error() string

func (*ServiceException) ErrorCode 

func (e *ServiceException) ErrorCode() string

func (*ServiceException) ErrorFault 

func (e *ServiceException) ErrorFault() smithy.ErrorFault

func (*ServiceException) ErrorMessage 

func (e *ServiceException) ErrorMessage() string

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string
}

You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder).

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string
}

The service is unable to process your request at this time.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type TargetContainerRepository added in v0.31.0 

type TargetContainerRepository struct {

	// The name of the container repository where the output container image is stored.
	// This name is prefixed by the repository location.
	//
	// This member is required.
	RepositoryName *string

	// Specifies the service in which this image was registered.
	//
	// This member is required.
	Service ContainerRepositoryService
}

The container repository where the output container image is stored.

Source Files

View all Source files

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.