types

package
v1.22.4 Latest Latest
Warning

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

 Go to latest Published: Feb 22, 2023 License: Apache-2.0 Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdditionalInstanceConfiguration added in v1.7.0 

type AdditionalInstanceConfiguration struct {

	// Contains settings for the Systems Manager agent on your build instance.
	SystemsManagerAgent *SystemsManagerAgent

	// Use this property to provide commands or a command script to run when you launch
	// your build instance. The userDataOverride property replaces any commands that
	// Image Builder might have added to ensure that Systems Manager is installed on
	// your Linux build instance. If you override the user data, make sure that you add
	// commands to install Systems Manager, if it is not pre-installed on your base
	// image. The user data is always base 64 encoded. For example, the following
	// commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
	// #!/bin/bash mkdir -p /var/bb/ touch /var
	UserDataOverride *string
	// contains filtered or unexported fields
}

In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances. Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base image includes the Systems Manager agent, then the AMI that you create will also include the agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create.

type Ami 

type Ami struct {

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

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

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

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

	// The Amazon Web Services Region of the Amazon EC2 AMI.
	Region *string

	// Image state shows the image status and the reason for that status.
	State *ImageState
	// contains filtered or unexported fields
}

Details of an Amazon 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 AMI 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 Amazon Web Services accounts
	// can use the AMI to launch instances.
	LaunchPermission *LaunchPermissionConfiguration

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

	// The ID of an account to which you want to distribute an image.
	TargetAccountIds []string
	// contains filtered or unexported fields
}

Define and configure the output AMIs of the pipeline.

type BuildType added in v1.15.0 

type BuildType string
const (
	BuildTypeUserInitiated BuildType = "USER_INITIATED"
	BuildTypeScheduled     BuildType = "SCHEDULED"
	BuildTypeImport        BuildType = "IMPORT"
)

Enum values for BuildType

func (BuildType) Values added in v1.15.0 

func (BuildType) Values() []BuildType

Values returns all known values for BuildType. 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 CallRateLimitExceededException 

type CallRateLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	// Component data contains the YAML document content for the component.
	Data *string

	// The date that Image Builder created the component.
	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

	// Indicates whether component source is hidden from view in the console, and from
	// component detail results for API, CLI, or SDK operations.
	Obfuscate bool

	// The owner of the component.
	Owner *string

	// Contains parameter details for each of the parameters that the component
	// document defined for the component.
	Parameters []ComponentParameterDetail

	// The operating system platform of the component.
	Platform Platform

	// Contains the name of the publisher if this is a third-party component.
	// Otherwise, this property is empty.
	Publisher *string

	// Describes the current status of the component. This is used for components that
	// are no longer active.
	State *ComponentState

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

	// The tags that apply to the component.
	Tags map[string]string

	// The component type specifies whether Image Builder uses the component to build
	// the image or only to test it.
	Type ComponentType

	// The version of the component.
	Version *string
	// contains filtered or unexported fields
}

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

	// A group of parameter settings that Image Builder uses to configure the component
	// for a specific recipe.
	Parameters []ComponentParameter
	// contains filtered or unexported fields
}

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 ComponentParameter added in v1.7.0 

type ComponentParameter struct {

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

	// Sets the value for the named component parameter.
	//
	// This member is required.
	Value []string
	// contains filtered or unexported fields
}

Contains a key/value pair that sets the named component parameter.

type ComponentParameterDetail added in v1.7.0 

type ComponentParameterDetail struct {

	// The name of this input parameter.
	//
	// This member is required.
	Name *string

	// The type of input this parameter provides. The currently supported value is
	// "string".
	//
	// This member is required.
	Type *string

	// The default value of this parameter if no input is provided.
	DefaultValue []string

	// Describes this parameter.
	Description *string
	// contains filtered or unexported fields
}

Defines a parameter that is used to provide configuration details for the component.

type ComponentState added in v1.10.0 

type ComponentState struct {

	// Describes how or why the component changed state.
	Reason *string

	// The current state of the component.
	Status ComponentStatus
	// contains filtered or unexported fields
}

A group of fields that describe the current status of components that are no longer active.

type ComponentStatus added in v1.10.0 

type ComponentStatus string
const (
	ComponentStatusDeprecated ComponentStatus = "DEPRECATED"
)

Enum values for ComponentStatus

func (ComponentStatus) Values added in v1.10.0 

func (ComponentStatus) Values() []ComponentStatus

Values returns all known values for ComponentStatus. 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 for the current version of the component.
	ChangeDescription *string

	// The original creation date of the component.
	DateCreated *string

	// The description of the component.
	Description *string

	// The name of the component.
	Name *string

	// Indicates whether component source is hidden from view in the console, and from
	// component detail results for API, CLI, or SDK operations.
	Obfuscate bool

	// The owner of the component.
	Owner *string

	// The operating system platform of the component.
	Platform Platform

	// Contains the name of the publisher if this is a third-party component.
	// Otherwise, this property is empty.
	Publisher *string

	// Describes the current status of the component.
	State *ComponentState

	// The operating system (OS) version that the component supports. If the OS
	// information is available, Image Builder performs a prefix match against the base
	// image OS version during image recipe creation.
	SupportedOsVersions []string

	// The tags that apply to the component.
	Tags map[string]string

	// The component type specifies whether Image Builder uses the component to build
	// the image or only to test it.
	Type ComponentType

	// The version of the component.
	Version *string
	// contains filtered or unexported fields
}

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. Semantic versioning is included
	// in each object's Amazon Resource Name (ARN), at the level that applies to that
	// object as follows:
	//
	// * Versionless ARNs and Name ARNs do not include specific
	// values in any of the nodes. The nodes are either left off entirely, or they are
	// specified as wildcards, for example: x.x.x.
	//
	// * Version ARNs have only the first
	// three nodes: ..
	//
	// * Build version ARNs have all four nodes, and point to a
	// specific build for a specific version of an object.
	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

	// he operating system (OS) version supported by the component. If the OS
	// information is available, a prefix match is performed against the base 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. The semantic version has four nodes: ../.
	// You can assign values for the first three, and can filter on all of them.
	// Assignment: For the first three nodes you can assign any positive integer value,
	// including zero, with an upper limit of 2^30-1, or 1073741823 for each node.
	// Image Builder automatically assigns the build number to the fourth node.
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	// Filtering: With semantic versioning, you have the flexibility to use wildcards
	// (x) to specify the most recent versions or nodes when selecting the base image
	// or components for your recipe. When you use a wildcard in any node, all nodes to
	// the right of the first wildcard must also be wildcards.
	Version *string
	// contains filtered or unexported fields
}

The defining characteristics of a specific version of an Amazon Web Services TOE component.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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. Semantic versioning is
	// included in each object's Amazon Resource Name (ARN), at the level that applies
	// to that object as follows:
	//
	// * Versionless ARNs and Name ARNs do not include
	// specific values in any of the nodes. The nodes are either left off entirely, or
	// they are specified as wildcards, for example: x.x.x.
	//
	// * Version ARNs have only
	// the first three nodes: ..
	//
	// * Build version ARNs have all four nodes, and point
	// to a specific build for a specific version of an object.
	Arn *string

	// Build and test components that are included in the container recipe. Recipes
	// require a minimum of one build component, and can have a maximum of 20 build and
	// test components in any combination.
	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

	// A group of options that can be used to configure an instance for building and
	// testing container images.
	InstanceConfiguration *InstanceConfiguration

	// 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 base 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. The semantic version has four
	// nodes: ../. You can assign values for the first three, and can filter on all of
	// them. Assignment: For the first three nodes you can assign any positive integer
	// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
	// node. Image Builder automatically assigns the build number to the fourth node.
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	// Filtering: With semantic versioning, you have the flexibility to use wildcards
	// (x) to specify the most recent versions or nodes when selecting the base image
	// or components for your recipe. When you use a wildcard in any node, all nodes to
	// the right of the first wildcard must also be wildcards.
	Version *string

	// The working directory for use during build and test workflows.
	WorkingDirectory *string
	// contains filtered or unexported fields
}

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 base 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
	// contains filtered or unexported fields
}

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 DiskImageFormat added in v1.15.0 

type DiskImageFormat string
const (
	DiskImageFormatVmdk DiskImageFormat = "VMDK"
	DiskImageFormatRaw  DiskImageFormat = "RAW"
	DiskImageFormatVhd  DiskImageFormat = "VHD"
)

Enum values for DiskImageFormat

func (DiskImageFormat) Values added in v1.15.0 

func (DiskImageFormat) Values() []DiskImageFormat

Values returns all known values for DiskImageFormat. 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 or AMI tags.
	AmiDistributionConfiguration *AmiDistributionConfiguration

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

	// The Windows faster-launching configurations to use for AMI distribution.
	FastLaunchConfigurations []FastLaunchConfiguration

	// A group of launchTemplateConfiguration settings that apply to image distribution
	// for specified accounts.
	LaunchTemplateConfigurations []LaunchTemplateConfiguration

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

	// Configure export settings to deliver disk images created from your image build,
	// using a file format that is compatible with your VMs in that Region.
	S3ExportConfiguration *S3ExportConfiguration
	// contains filtered or unexported fields
}

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 distribution objects that apply Region-specific settings for the deployment
	// of the image to targeted Regions.
	Distributions []Distribution

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

	// The tags of the distribution configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// For GP3 volumes only – The throughput in MiB/s that the volume supports.
	Throughput *int32

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

	// Use to override the device's volume type.
	VolumeType EbsVolumeType
	// contains filtered or unexported fields
}

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"
	EbsVolumeTypeGp3      EbsVolumeType = "gp3"
	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 FastLaunchConfiguration added in v1.18.0 

type FastLaunchConfiguration struct {

	// A Boolean that represents the current state of faster launching for the Windows
	// AMI. Set to true to start using Windows faster launching, or false to stop using
	// it.
	//
	// This member is required.
	Enabled bool

	// The owner account ID for the fast-launch enabled Windows AMI.
	AccountId *string

	// The launch template that the fast-launch enabled Windows AMI uses when it
	// launches Windows instances to create pre-provisioned snapshots.
	LaunchTemplate *FastLaunchLaunchTemplateSpecification

	// The maximum number of parallel instances that are launched for creating
	// resources.
	MaxParallelLaunches *int32

	// Configuration settings for managing the number of snapshots that are created
	// from pre-provisioned instances for the Windows AMI when faster launching is
	// enabled.
	SnapshotConfiguration *FastLaunchSnapshotConfiguration
	// contains filtered or unexported fields
}

Define and configure faster launching for output Windows AMIs.

type FastLaunchLaunchTemplateSpecification added in v1.18.0 

type FastLaunchLaunchTemplateSpecification struct {

	// The ID of the launch template to use for faster launching for a Windows AMI.
	LaunchTemplateId *string

	// The name of the launch template to use for faster launching for a Windows AMI.
	LaunchTemplateName *string

	// The version of the launch template to use for faster launching for a Windows
	// AMI.
	LaunchTemplateVersion *string
	// contains filtered or unexported fields
}

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled. You can specify either the launchTemplateName or the launchTemplateId, but not both.

type FastLaunchSnapshotConfiguration added in v1.18.0 

type FastLaunchSnapshotConfiguration struct {

	// The number of pre-provisioned snapshots to keep on hand for a fast-launch
	// enabled Windows AMI.
	TargetResourceCount *int32
	// contains filtered or unexported fields
}

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

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
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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. Semantic versioning is included in
	// each object's Amazon Resource Name (ARN), at the level that applies to that
	// object as follows:
	//
	// * Versionless ARNs and Name ARNs do not include specific
	// values in any of the nodes. The nodes are either left off entirely, or they are
	// specified as wildcards, for example: x.x.x.
	//
	// * Version ARNs have only the first
	// three nodes: ..
	//
	// * Build version ARNs have all four nodes, and point to a
	// specific build for a specific version of an object.
	Arn *string

	// Indicates the type of build that created this image. The build can be initiated
	// in the following ways:
	//
	// * USER_INITIATED – A manual pipeline build request.
	//
	// *
	// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
	// pipeline, or from EventBridge.
	//
	// * IMPORT – A VM import created the image to use
	// as the base image for the recipe.
	BuildType BuildType

	// For container images, this is the container recipe that Image Builder used to
	// create the image. For images that distribute an AMI, this is empty.
	ContainerRecipe *ContainerRecipe

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

	// The distribution configuration that Image Builder used to create this image.
	DistributionConfiguration *DistributionConfiguration

	// Indicates whether Image Builder collects additional information about the image,
	// such as the operating system (OS) version and package list.
	EnhancedImageMetadataEnabled *bool

	// For images that distribute an AMI, this is the image recipe that Image Builder
	// used to create the image. For container images, this is empty.
	ImageRecipe *ImageRecipe

	// The origin of the base image that Image Builder used to build this image.
	ImageSource ImageSource

	// The image tests that ran when that Image Builder created this image.
	ImageTestsConfiguration *ImageTestsConfiguration

	// The infrastructure that Image Builder used to create this image.
	InfrastructureConfiguration *InfrastructureConfiguration

	// The name of the image.
	Name *string

	// The operating system version for instances that launch from this image. For
	// example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
	OsVersion *string

	// The output resources that Image Builder produces for this image.
	OutputResources *OutputResources

	// The image operating system platform, such as Linux or Windows.
	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 that apply to this image.
	Tags map[string]string

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

	// The semantic version of the image. The semantic version has four nodes: ../. You
	// can assign values for the first three, and can filter on all of them.
	// Assignment: For the first three nodes you can assign any positive integer value,
	// including zero, with an upper limit of 2^30-1, or 1073741823 for each node.
	// Image Builder automatically assigns the build number to the fourth node.
	// Patterns: You can use any numeric pattern that adheres to the assignment
	// requirements for the nodes that you can assign. For example, you might choose a
	// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
	// Filtering: With semantic versioning, you have the flexibility to use wildcards
	// (x) to specify the most recent versions or nodes when selecting the base image
	// or components for your recipe. When you use a wildcard in any node, all nodes to
	// the right of the first wildcard must also be wildcards.
	Version *string
	// contains filtered or unexported fields
}

An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.

type ImagePackage added in v1.2.0 

type ImagePackage struct {

	// The name of the package as reported to the operating system package manager.
	PackageName *string

	// The version of the package as reported to the operating system package manager.
	PackageVersion *string
	// contains filtered or unexported fields
}

Represents a package installed on an Image Builder image.

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

	// This is no longer supported, and does not return a value.
	DateLastRun *string

	// This is no longer supported, and does not return a value.
	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
	// contains filtered or unexported fields
}

Details of an image pipeline.

type ImageRecipe 

type ImageRecipe struct {

	// Before you create a new AMI, Image Builder launches temporary Amazon EC2
	// instances to build and test your image configuration. Instance configuration
	// adds a layer of control over those instances. You can define settings and add
	// scripts to run when an instance is launched from your AMI.
	AdditionalInstanceConfiguration *AdditionalInstanceConfiguration

	// 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 that are included in the image recipe. Recipes require a minimum
	// of one build component, and can have a maximum of 20 build and test components
	// in any combination.
	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 base 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
	// contains filtered or unexported fields
}

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 base 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
	// contains filtered or unexported fields
}

A summary of an image recipe.

type ImageSource added in v1.22.0 

type ImageSource string
const (
	ImageSourceAmazonManaged  ImageSource = "AMAZON_MANAGED"
	ImageSourceAwsMarketplace ImageSource = "AWS_MARKETPLACE"
	ImageSourceImported       ImageSource = "IMPORTED"
	ImageSourceCustom         ImageSource = "CUSTOM"
)

Enum values for ImageSource

func (ImageSource) Values added in v1.22.0 

func (ImageSource) Values() []ImageSource

Values returns all known values for ImageSource. 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 ImageState 

type ImageState struct {

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

	// The status of the image.
	Status ImageStatus
	// contains filtered or unexported fields
}

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

	// Indicates the type of build that created this image. The build can be initiated
	// in the following ways:
	//
	// * USER_INITIATED – A manual pipeline build request.
	//
	// *
	// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
	// pipeline, or from EventBridge.
	//
	// * IMPORT – A VM import created the image to use
	// as the base image for the recipe.
	BuildType BuildType

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

	// The origin of the base image that Image Builder used to build this image.
	ImageSource ImageSource

	// The name of the image.
	Name *string

	// The operating system version of the instances that launch from this image. For
	// example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
	OsVersion *string

	// The output resources that Image Builder produced when it created this image.
	OutputResources *OutputResources

	// The owner of the image.
	Owner *string

	// The image operating system platform, such as Linux or Windows.
	Platform Platform

	// The state of the image.
	State *ImageState

	// The tags that apply to this image.
	Tags map[string]string

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

	// The version of the image.
	Version *string
	// contains filtered or unexported fields
}

An image summary.

type ImageTestsConfiguration 

type ImageTestsConfiguration struct {

	// Determines if tests should run after building the image. Image Builder defaults
	// to enable tests to run following the image build, before image distribution.
	ImageTestsEnabled *bool

	// The maximum time in minutes that tests are permitted to run. The timeoutMinutes
	// attribute is not currently active. This value is ignored.
	TimeoutMinutes *int32
	// contains filtered or unexported fields
}

Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.

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 a specific version of an Image Builder image.
	// Semantic versioning is included in each object's Amazon Resource Name (ARN), at
	// the level that applies to that object as follows:
	//
	// * Versionless ARNs and Name
	// ARNs do not include specific values in any of the nodes. The nodes are either
	// left off entirely, or they are specified as wildcards, for example: x.x.x.
	//
	// *
	// Version ARNs have only the first three nodes: ..
	//
	// * Build version ARNs have all
	// four nodes, and point to a specific build for a specific version of an object.
	Arn *string

	// Indicates the type of build that created this image. The build can be initiated
	// in the following ways:
	//
	// * USER_INITIATED – A manual pipeline build request.
	//
	// *
	// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
	// pipeline, or from EventBridge.
	//
	// * IMPORT – A VM import created the image to use
	// as the base image for the recipe.
	BuildType BuildType

	// The date on which this specific version of the Image Builder image was created.
	DateCreated *string

	// The origin of the base image that Image Builder used to build this image.
	ImageSource ImageSource

	// The name of this specific version of an Image Builder image.
	Name *string

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

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

	// The operating system platform of the image version, for example "Windows" or
	// "Linux".
	Platform Platform

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

	// Details for a specific version of an Image Builder image. This version follows
	// the semantic version syntax. The semantic version has four nodes: ../. You can
	// assign values for the first three, and can filter on all of them. Assignment:
	// For the first three nodes you can assign any positive integer value, including
	// zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder
	// automatically assigns the build number to the fourth node. Patterns: You can use
	// any numeric pattern that adheres to the assignment requirements for the nodes
	// that you can assign. For example, you might choose a software version pattern,
	// such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic
	// versioning, you have the flexibility to use wildcards (x) to specify the most
	// recent versions or nodes when selecting the base image or components for your
	// recipe. When you use a wildcard in any node, all nodes to the right of the first
	// wildcard must also be wildcards.
	Version *string
	// contains filtered or unexported fields
}

The defining characteristics of a specific version of an Image Builder image.

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 metadata option settings for the infrastructure configuration.
	InstanceMetadataOptions *InstanceMetadataOptions

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

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

	// The Amazon 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 Amazon Resource Name (ARN) for the SNS topic to which we send image build
	// event notifications. EC2 Image Builder is unable to send notifications to SNS
	// topics that are encrypted using keys from other accounts. The key that is used
	// to encrypt the SNS topic must reside in the account that the Image Builder
	// service runs under.
	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
	// contains filtered or unexported fields
}

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 instance profile of the infrastructure configuration.
	InstanceProfileName *string

	// The instance types of the infrastructure configuration.
	InstanceTypes []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
	// contains filtered or unexported fields
}

The infrastructure used when building Amazon 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 base image.
	NoDevice *string

	// Use to manage instance ephemeral devices.
	VirtualName *string
	// contains filtered or unexported fields
}

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

type InstanceConfiguration added in v1.3.0 

type InstanceConfiguration struct {

	// Defines the block devices to attach for building an instance from this Image
	// Builder AMI.
	BlockDeviceMappings []InstanceBlockDeviceMapping

	// The AMI ID to use as the base image for a container build and test instance. If
	// not specified, Image Builder will use the appropriate ECS-optimized AMI as a
	// base image.
	Image *string
	// contains filtered or unexported fields
}

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

type InstanceMetadataOptions added in v1.10.0 

type InstanceMetadataOptions struct {

	// Limit the number of hops that an instance metadata request can traverse to reach
	// its destination. The default is one hop. However, if HTTP tokens are required,
	// container image builds need a minimum of two hops.
	HttpPutResponseHopLimit *int32

	// Indicates whether a signed token header is required for instance metadata
	// retrieval requests. The values affect the response as follows:
	//
	// * required –
	// When you retrieve the IAM role credentials, version 2.0 credentials are returned
	// in all cases.
	//
	// * optional – You can include a signed token header in your
	// request to retrieve instance metadata, or you can leave it out. If you include
	// it, version 2.0 credentials are returned for the IAM role. Otherwise, version
	// 1.0 credentials are returned.
	//
	// The default setting is optional.
	HttpTokens *string
	// contains filtered or unexported fields
}

The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) in the Amazon EC2 Windows Guide for Windows instances.

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 ARN for an Amazon Web Services Organization that you want to share your AMI
	// with. For more information, see What is Organizations?
	// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html).
	OrganizationArns []string

	// The ARN for an Organizations organizational unit (OU) that you want to share
	// your AMI with. For more information about key concepts for Organizations, see
	// Organizations terminology and concepts
	// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html).
	OrganizationalUnitArns []string

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

	// The Amazon Web Services account ID.
	UserIds []string
	// contains filtered or unexported fields
}

Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon 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 Amazon EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html).

type LaunchTemplateConfiguration added in v1.3.0 

type LaunchTemplateConfiguration struct {

	// Identifies the Amazon EC2 launch template to use.
	//
	// This member is required.
	LaunchTemplateId *string

	// The account ID that this configuration applies to.
	AccountId *string

	// Set the specified Amazon EC2 launch template as the default launch template for
	// the specified account.
	SetDefaultVersion bool
	// contains filtered or unexported fields
}

Identifies an Amazon EC2 launch template to use for a specific account.

type Logging 

type Logging struct {

	// The Amazon S3 logging configuration.
	S3Logs *S3Logs
	// contains filtered or unexported fields
}

Logging configuration defines where Image Builder uploads your logs.

type OutputResources 

type OutputResources struct {

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

	// Container images that the pipeline has generated and stored in the output
	// repository.
	Containers []Container
	// contains filtered or unexported fields
}

The resources produced by this image.

type Ownership 

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

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 S3ExportConfiguration added in v1.15.0 

type S3ExportConfiguration struct {

	// Export the updated image to one of the following supported disk image
	// formats:
	//
	// * Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft
	// Hyper-V virtualization products.
	//
	// * Stream-optimized ESX Virtual Machine Disk
	// (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.
	//
	// *
	// Raw – Raw format.
	//
	// This member is required.
	DiskImageFormat DiskImageFormat

	// The name of the role that grants VM Import/Export permission to export images to
	// your S3 bucket.
	//
	// This member is required.
	RoleName *string

	// The S3 bucket in which to store the output disk images for your VM.
	//
	// This member is required.
	S3Bucket *string

	// The Amazon S3 path for the bucket where the output disk images for your VM are
	// stored.
	S3Prefix *string
	// contains filtered or unexported fields
}

Properties that configure export from your build instance to a compatible file format for your VM.

type S3Logs 

type S3Logs struct {

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

	// The Amazon S3 path to the bucket where the logs are stored.
	S3KeyPrefix *string
	// contains filtered or unexported fields
}

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 base 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

	// The timezone that applies to the scheduling expression. For example, "Etc/UTC",
	// "America/Los_Angeles" in the IANA timezone format
	// (https://www.joda.org/joda-time/timezones.html). If not specified this defaults
	// to UTC.
	Timezone *string
	// contains filtered or unexported fields
}

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

type ServiceException 

type ServiceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 SystemsManagerAgent added in v1.7.0 

type SystemsManagerAgent struct {

	// Controls whether the Systems Manager agent is removed from your final build
	// image, prior to creating the new AMI. If this is set to true, then the agent is
	// removed from the final image. If it's set to false, then the agent is left in,
	// so that it is included in the new AMI. The default value is false.
	UninstallAfterBuild *bool
	// contains filtered or unexported fields
}

Contains settings for the Systems Manager agent on your build instance.

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
	// contains filtered or unexported fields
}

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.