Documentation

Overview

Package imagebuilder provides the client and types for making API requests to EC2 Image Builder.

EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

See https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02 for more information on this service.

See imagebuilder package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/imagebuilder/

Using the Client

To contact EC2 Image Builder with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the EC2 Image Builder client Imagebuilder for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/imagebuilder/#New

Index

Constants

View Source
const (
	// ComponentTypeBuild is a ComponentType enum value
	ComponentTypeBuild = "BUILD"

	// ComponentTypeTest is a ComponentType enum value
	ComponentTypeTest = "TEST"
)
View Source
const (
	// EbsVolumeTypeStandard is a EbsVolumeType enum value
	EbsVolumeTypeStandard = "standard"

	// EbsVolumeTypeIo1 is a EbsVolumeType enum value
	EbsVolumeTypeIo1 = "io1"

	// EbsVolumeTypeIo2 is a EbsVolumeType enum value
	EbsVolumeTypeIo2 = "io2"

	// EbsVolumeTypeGp2 is a EbsVolumeType enum value
	EbsVolumeTypeGp2 = "gp2"

	// EbsVolumeTypeGp3 is a EbsVolumeType enum value
	EbsVolumeTypeGp3 = "gp3"

	// EbsVolumeTypeSc1 is a EbsVolumeType enum value
	EbsVolumeTypeSc1 = "sc1"

	// EbsVolumeTypeSt1 is a EbsVolumeType enum value
	EbsVolumeTypeSt1 = "st1"
)
View Source
const (
	// ImageStatusPending is a ImageStatus enum value
	ImageStatusPending = "PENDING"

	// ImageStatusCreating is a ImageStatus enum value
	ImageStatusCreating = "CREATING"

	// ImageStatusBuilding is a ImageStatus enum value
	ImageStatusBuilding = "BUILDING"

	// ImageStatusTesting is a ImageStatus enum value
	ImageStatusTesting = "TESTING"

	// ImageStatusDistributing is a ImageStatus enum value
	ImageStatusDistributing = "DISTRIBUTING"

	// ImageStatusIntegrating is a ImageStatus enum value
	ImageStatusIntegrating = "INTEGRATING"

	// ImageStatusAvailable is a ImageStatus enum value
	ImageStatusAvailable = "AVAILABLE"

	// ImageStatusCancelled is a ImageStatus enum value
	ImageStatusCancelled = "CANCELLED"

	// ImageStatusFailed is a ImageStatus enum value
	ImageStatusFailed = "FAILED"

	// ImageStatusDeprecated is a ImageStatus enum value
	ImageStatusDeprecated = "DEPRECATED"

	// ImageStatusDeleted is a ImageStatus enum value
	ImageStatusDeleted = "DELETED"
)
View Source
const (
	// ImageTypeAmi is a ImageType enum value
	ImageTypeAmi = "AMI"

	// ImageTypeDocker is a ImageType enum value
	ImageTypeDocker = "DOCKER"
)
View Source
const (
	// OwnershipSelf is a Ownership enum value
	OwnershipSelf = "Self"

	// OwnershipShared is a Ownership enum value
	OwnershipShared = "Shared"

	// OwnershipAmazon is a Ownership enum value
	OwnershipAmazon = "Amazon"
)
View Source
const (
	// PipelineExecutionStartConditionExpressionMatchOnly is a PipelineExecutionStartCondition enum value
	PipelineExecutionStartConditionExpressionMatchOnly = "EXPRESSION_MATCH_ONLY"

	// PipelineExecutionStartConditionExpressionMatchAndDependencyUpdatesAvailable is a PipelineExecutionStartCondition enum value
	PipelineExecutionStartConditionExpressionMatchAndDependencyUpdatesAvailable = "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
)
View Source
const (
	// PipelineStatusDisabled is a PipelineStatus enum value
	PipelineStatusDisabled = "DISABLED"

	// PipelineStatusEnabled is a PipelineStatus enum value
	PipelineStatusEnabled = "ENABLED"
)
View Source
const (
	// PlatformWindows is a Platform enum value
	PlatformWindows = "Windows"

	// PlatformLinux is a Platform enum value
	PlatformLinux = "Linux"
)
View Source
const (

	// ErrCodeCallRateLimitExceededException for service response error code
	// "CallRateLimitExceededException".
	//
	// You have exceeded the permitted request rate for the specific operation.
	ErrCodeCallRateLimitExceededException = "CallRateLimitExceededException"

	// ErrCodeClientException for service response error code
	// "ClientException".
	//
	// 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.
	ErrCodeClientException = "ClientException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// You are not authorized to perform the requested operation.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeIdempotentParameterMismatchException for service response error code
	// "IdempotentParameterMismatchException".
	//
	// You have specified a client token for an operation using parameter values
	// that differ from a previous request that used the same client token.
	ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// You have provided an invalid pagination token in your request.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombinationException".
	//
	// You have specified two or more mutually exclusive parameters. Review the
	// error message for details.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombinationException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// The specified parameter is invalid. Review the available parameters for the
	// API request.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// The value that you provided for the specified parameter is invalid.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// You have made a request for an action that is not supported by the service.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeInvalidVersionNumberException for service response error code
	// "InvalidVersionNumberException".
	//
	// Your version number is out of bounds or does not follow the required syntax.
	ErrCodeInvalidVersionNumberException = "InvalidVersionNumberException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource that you are trying to create already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceDependencyException for service response error code
	// "ResourceDependencyException".
	//
	// You have attempted to mutate or delete a resource with a dependency that
	// prohibits this action. See the error message for more details.
	ErrCodeResourceDependencyException = "ResourceDependencyException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource that you are trying to operate on is currently in use. Review
	// the message details and retry later.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// At least one of the resources referenced by your request does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceException for service response error code
	// "ServiceException".
	//
	// This exception is thrown when the service encounters an unrecoverable exception.
	ErrCodeServiceException = "ServiceException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// 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).
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is unable to process your request at this time.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
View Source
const (
	ServiceName = "imagebuilder" // Name of service.
	EndpointsID = ServiceName    // ID to lookup a service endpoint with.
	ServiceID   = "imagebuilder" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ComponentFormatShell is a ComponentFormat enum value
	ComponentFormatShell = "SHELL"
)
View Source
const (
	// ContainerRepositoryServiceEcr is a ContainerRepositoryService enum value
	ContainerRepositoryServiceEcr = "ECR"
)
View Source
const (
	// ContainerTypeDocker is a ContainerType enum value
	ContainerTypeDocker = "DOCKER"
)

Variables

This section is empty.

Functions

func ComponentFormat_Values

func ComponentFormat_Values() []string

ComponentFormat_Values returns all elements of the ComponentFormat enum

func ComponentType_Values

func ComponentType_Values() []string

ComponentType_Values returns all elements of the ComponentType enum

func ContainerRepositoryService_Values

func ContainerRepositoryService_Values() []string

ContainerRepositoryService_Values returns all elements of the ContainerRepositoryService enum

func ContainerType_Values

func ContainerType_Values() []string

ContainerType_Values returns all elements of the ContainerType enum

func EbsVolumeType_Values

func EbsVolumeType_Values() []string

EbsVolumeType_Values returns all elements of the EbsVolumeType enum

func ImageStatus_Values

func ImageStatus_Values() []string

ImageStatus_Values returns all elements of the ImageStatus enum

func ImageType_Values

func ImageType_Values() []string

ImageType_Values returns all elements of the ImageType enum

func Ownership_Values

func Ownership_Values() []string

Ownership_Values returns all elements of the Ownership enum

func PipelineExecutionStartCondition_Values

func PipelineExecutionStartCondition_Values() []string

PipelineExecutionStartCondition_Values returns all elements of the PipelineExecutionStartCondition enum

func PipelineStatus_Values

func PipelineStatus_Values() []string

PipelineStatus_Values returns all elements of the PipelineStatus enum

func Platform_Values

func Platform_Values() []string

Platform_Values returns all elements of the Platform enum

Types

type Ami

type Ami struct {

	// The account ID of the owner of the AMI.
	AccountId *string `locationName:"accountId" min:"1" type:"string"`

	// The description of the EC2 AMI. Minimum and maximum length are in characters.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The AMI ID of the EC2 AMI.
	Image *string `locationName:"image" min:"1" type:"string"`

	// The name of the EC2 AMI.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The AWS Region of the EC2 AMI.
	Region *string `locationName:"region" min:"1" type:"string"`

	// Image state shows the image status and the reason for that status.
	State *ImageState `locationName:"state" type:"structure"`
	// contains filtered or unexported fields
}

Details of an EC2 AMI.

func (Ami) GoString

func (s Ami) GoString() string

GoString returns the string representation

func (*Ami) SetAccountId

func (s *Ami) SetAccountId(v string) *Ami

SetAccountId sets the AccountId field's value.

func (*Ami) SetDescription

func (s *Ami) SetDescription(v string) *Ami

SetDescription sets the Description field's value.

func (*Ami) SetImage

func (s *Ami) SetImage(v string) *Ami

SetImage sets the Image field's value.

func (*Ami) SetName

func (s *Ami) SetName(v string) *Ami

SetName sets the Name field's value.

func (*Ami) SetRegion

func (s *Ami) SetRegion(v string) *Ami

SetRegion sets the Region field's value.

func (*Ami) SetState

func (s *Ami) SetState(v *ImageState) *Ami

SetState sets the State field's value.

func (Ami) String

func (s Ami) String() string

String returns the string representation

type AmiDistributionConfiguration

type AmiDistributionConfiguration struct {

	// The tags to apply to AMIs distributed to this Region.
	AmiTags map[string]*string `locationName:"amiTags" min:"1" type:"map"`

	// The description of the distribution configuration. Minimum and maximum length
	// are in characters.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The KMS key identifier used to encrypt the distributed image.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// Launch permissions can be used to configure which AWS accounts can use the
	// AMI to launch instances.
	LaunchPermission *LaunchPermissionConfiguration `locationName:"launchPermission" type:"structure"`

	// The name of the distribution configuration.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The ID of an account to which you want to distribute an image.
	TargetAccountIds []*string `locationName:"targetAccountIds" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Define and configure the output AMIs of the pipeline.

func (AmiDistributionConfiguration) GoString

func (s AmiDistributionConfiguration) GoString() string

GoString returns the string representation

func (*AmiDistributionConfiguration) SetAmiTags

SetAmiTags sets the AmiTags field's value.

func (*AmiDistributionConfiguration) SetDescription

SetDescription sets the Description field's value.

func (*AmiDistributionConfiguration) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AmiDistributionConfiguration) SetLaunchPermission

SetLaunchPermission sets the LaunchPermission field's value.

func (*AmiDistributionConfiguration) SetName

SetName sets the Name field's value.

func (*AmiDistributionConfiguration) SetTargetAccountIds

SetTargetAccountIds sets the TargetAccountIds field's value.

func (AmiDistributionConfiguration) String

String returns the string representation

func (*AmiDistributionConfiguration) Validate

func (s *AmiDistributionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CallRateLimitExceededException

type CallRateLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*CallRateLimitExceededException) Code

Code returns the exception type name.

func (*CallRateLimitExceededException) Error

func (CallRateLimitExceededException) GoString

GoString returns the string representation

func (*CallRateLimitExceededException) Message

Message returns the exception's message.

func (*CallRateLimitExceededException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CallRateLimitExceededException) RequestID

func (s *CallRateLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CallRateLimitExceededException) StatusCode

func (s *CallRateLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CallRateLimitExceededException) String

String returns the string representation

type CancelImageCreationInput

type CancelImageCreationInput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the image whose creation you want to cancel.
	//
	// ImageBuildVersionArn is a required field
	ImageBuildVersionArn *string `locationName:"imageBuildVersionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelImageCreationInput) GoString

func (s CancelImageCreationInput) GoString() string

GoString returns the string representation

func (*CancelImageCreationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CancelImageCreationInput) SetImageBuildVersionArn

func (s *CancelImageCreationInput) SetImageBuildVersionArn(v string) *CancelImageCreationInput

SetImageBuildVersionArn sets the ImageBuildVersionArn field's value.

func (CancelImageCreationInput) String

func (s CancelImageCreationInput) String() string

String returns the string representation

func (*CancelImageCreationInput) Validate

func (s *CancelImageCreationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelImageCreationOutput

type CancelImageCreationOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
	ImageBuildVersionArn *string `locationName:"imageBuildVersionArn" type:"string"`

	// The request ID that uniquely identifies this request.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CancelImageCreationOutput) GoString

func (s CancelImageCreationOutput) GoString() string

GoString returns the string representation

func (*CancelImageCreationOutput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CancelImageCreationOutput) SetImageBuildVersionArn

func (s *CancelImageCreationOutput) SetImageBuildVersionArn(v string) *CancelImageCreationOutput

SetImageBuildVersionArn sets the ImageBuildVersionArn field's value.

func (*CancelImageCreationOutput) SetRequestId

SetRequestId sets the RequestId field's value.

func (CancelImageCreationOutput) String

func (s CancelImageCreationOutput) String() string

String returns the string representation

type ClientException

type ClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code

func (s *ClientException) Code() string

Code returns the exception type name.

func (*ClientException) Error

func (s *ClientException) Error() string

func (ClientException) GoString

func (s ClientException) GoString() string

GoString returns the string representation

func (*ClientException) Message

func (s *ClientException) Message() string

Message returns the exception's message.

func (*ClientException) OrigErr

func (s *ClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientException) RequestID

func (s *ClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientException) StatusCode

func (s *ClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClientException) String

func (s ClientException) String() string

String returns the string representation

type Component

type Component struct {

	// The Amazon Resource Name (ARN) of the component.
	Arn *string `locationName:"arn" type:"string"`

	// The change description of the component.
	ChangeDescription *string `locationName:"changeDescription" min:"1" type:"string"`

	// The data of the component.
	Data *string `locationName:"data" type:"string"`

	// The date that the component was created.
	DateCreated *string `locationName:"dateCreated" type:"string"`

	// The description of the component.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The encryption status of the component.
	Encrypted *bool `locationName:"encrypted" type:"boolean"`

	// The KMS key identifier used to encrypt the component.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// The name of the component.
	Name *string `locationName:"name" type:"string"`

	// The owner of the component.
	Owner *string `locationName:"owner" min:"1" type:"string"`

	// The platform of the component.
	Platform *string `locationName:"platform" type:"string" enum:"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 `locationName:"supportedOsVersions" min:"1" type:"list"`

	// The tags associated with the component.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The type of the component denotes whether the component is used to build
	// the image or only to test it.
	Type *string `locationName:"type" type:"string" enum:"ComponentType"`

	// The version of the component.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A detailed view of a component.

func (Component) GoString

func (s Component) GoString() string

GoString returns the string representation

func (*Component) SetArn

func (s *Component) SetArn(v string) *Component

SetArn sets the Arn field's value.

func (*Component) SetChangeDescription

func (s *Component) SetChangeDescription(v string) *Component

SetChangeDescription sets the ChangeDescription field's value.

func (*Component) SetData

func (s *Component) SetData(v string) *Component

SetData sets the Data field's value.

func (*Component) SetDateCreated

func (s *Component) SetDateCreated(v string) *Component

SetDateCreated sets the DateCreated field's value.

func (*Component) SetDescription

func (s *Component) SetDescription(v string) *Component

SetDescription sets the Description field's value.

func (*Component) SetEncrypted

func (s *Component) SetEncrypted(v bool) *Component

SetEncrypted sets the Encrypted field's value.

func (*Component) SetKmsKeyId

func (s *Component) SetKmsKeyId(v string) *Component

SetKmsKeyId sets the KmsKeyId field's value.

func (*Component) SetName

func (s *Component) SetName(v string) *Component

SetName sets the Name field's value.

func (*Component) SetOwner

func (s *Component) SetOwner(v string) *Component

SetOwner sets the Owner field's value.

func (*Component) SetPlatform

func (s *Component) SetPlatform(v string) *Component

SetPlatform sets the Platform field's value.

func (*Component) SetSupportedOsVersions

func (s *Component) SetSupportedOsVersions(v []*string) *Component

SetSupportedOsVersions sets the SupportedOsVersions field's value.

func (*Component) SetTags

func (s *Component) SetTags(v map[string]*string) *Component

SetTags sets the Tags field's value.

func (*Component) SetType

func (s *Component) SetType(v string) *Component

SetType sets the Type field's value.

func (*Component) SetVersion

func (s *Component) SetVersion(v string) *Component

SetVersion sets the Version field's value.

func (Component) String

func (s Component) String() string

String returns the string representation

type ComponentConfiguration

type ComponentConfiguration struct {

	// The Amazon Resource Name (ARN) of the component.
	//
	// ComponentArn is a required field
	ComponentArn *string `locationName:"componentArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration details of the component.

func (ComponentConfiguration) GoString

func (s ComponentConfiguration) GoString() string

GoString returns the string representation

func (*ComponentConfiguration) SetComponentArn

func (s *ComponentConfiguration) SetComponentArn(v string) *ComponentConfiguration

SetComponentArn sets the ComponentArn field's value.

func (ComponentConfiguration) String

func (s ComponentConfiguration) String() string

String returns the string representation

func (*ComponentConfiguration) Validate

func (s *ComponentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentSummary

type ComponentSummary struct {

	// The Amazon Resource Name (ARN) of the component.
	Arn *string `locationName:"arn" type:"string"`

	// The change description of the component.
	ChangeDescription *string `locationName:"changeDescription" min:"1" type:"string"`

	// The date that the component was created.
	DateCreated *string `locationName:"dateCreated" type:"string"`

	// The description of the component.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The name of the component.
	Name *string `locationName:"name" type:"string"`

	// The owner of the component.
	Owner *string `locationName:"owner" min:"1" type:"string"`

	// The platform of the component.
	Platform *string `locationName:"platform" type:"string" enum:"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 `locationName:"supportedOsVersions" min:"1" type:"list"`

	// The tags associated with the component.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The type of the component denotes whether the component is used to build
	// the image or only to test it.
	Type *string `locationName:"type" type:"string" enum:"ComponentType"`

	// The version of the component.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A high-level summary of a component.

func (ComponentSummary) GoString

func (s ComponentSummary) GoString() string

GoString returns the string representation

func (*ComponentSummary) SetArn

SetArn sets the Arn field's value.

func (*ComponentSummary) SetChangeDescription

func (s *ComponentSummary) SetChangeDescription(v string) *ComponentSummary

SetChangeDescription sets the ChangeDescription field's value.

func (*ComponentSummary) SetDateCreated

func (s *ComponentSummary) SetDateCreated(v string) *ComponentSummary

SetDateCreated sets the DateCreated field's value.

func (*ComponentSummary) SetDescription

func (s *ComponentSummary) SetDescription(v string) *ComponentSummary

SetDescription sets the Description field's value.

func (*ComponentSummary) SetName

func (s *ComponentSummary) SetName(v string) *ComponentSummary

SetName sets the Name field's value.

func (*ComponentSummary) SetOwner

func (s *ComponentSummary) SetOwner(v string) *ComponentSummary

SetOwner sets the Owner field's value.

func (*ComponentSummary) SetPlatform

func (s *ComponentSummary) SetPlatform(v string) *ComponentSummary

SetPlatform sets the Platform field's value.

func (*ComponentSummary) SetSupportedOsVersions

func (s *ComponentSummary) SetSupportedOsVersions(v []*string) *ComponentSummary

SetSupportedOsVersions sets the SupportedOsVersions field's value.

func (*ComponentSummary) SetTags

func (s *ComponentSummary) SetTags(v map[string]*string) *ComponentSummary

SetTags sets the Tags field's value.

func (*ComponentSummary) SetType

func (s *ComponentSummary) SetType(v string) *ComponentSummary

SetType sets the Type field's value.

func (*ComponentSummary) SetVersion

func (s *ComponentSummary) SetVersion(v string) *ComponentSummary

SetVersion sets the Version field's value.

func (ComponentSummary) String

func (s ComponentSummary) String() string

String returns the string representation

type ComponentVersion

type ComponentVersion struct {

	// The Amazon Resource Name (ARN) of the component.
	Arn *string `locationName:"arn" type:"string"`

	// The date that the component was created.
	DateCreated *string `locationName:"dateCreated" type:"string"`

	// The description of the component.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The name of the component.
	Name *string `locationName:"name" type:"string"`

	// The owner of the component.
	Owner *string `locationName:"owner" min:"1" type:"string"`

	// The platform of the component.
	Platform *string `locationName:"platform" type:"string" enum:"Platform"`

	// he 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 `locationName:"supportedOsVersions" min:"1" type:"list"`

	// The type of the component denotes whether the component is used to build
	// the image or only to test it.
	Type *string `locationName:"type" type:"string" enum:"ComponentType"`

	// The semantic version of the component.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A high-level overview of a component semantic version.

func (ComponentVersion) GoString

func (s ComponentVersion) GoString() string

GoString returns the string representation

func (*ComponentVersion) SetArn

SetArn sets the Arn field's value.

func (*ComponentVersion) SetDateCreated

func (s *ComponentVersion) SetDateCreated(v string) *ComponentVersion

SetDateCreated sets the DateCreated field's value.

func (*ComponentVersion) SetDescription

func (s *ComponentVersion) SetDescription(v string) *ComponentVersion

SetDescription sets the Description field's value.

func (*ComponentVersion) SetName

func (s *ComponentVersion) SetName(v string) *ComponentVersion

SetName sets the Name field's value.

func (*ComponentVersion) SetOwner

func (s *ComponentVersion) SetOwner(v string) *ComponentVersion

SetOwner sets the Owner field's value.

func (*ComponentVersion) SetPlatform

func (s *ComponentVersion) SetPlatform(v string) *ComponentVersion

SetPlatform sets the Platform field's value.

func (*ComponentVersion) SetSupportedOsVersions

func (s *ComponentVersion) SetSupportedOsVersions(v []*string) *ComponentVersion

SetSupportedOsVersions sets the SupportedOsVersions field's value.

func (*ComponentVersion) SetType

func (s *ComponentVersion) SetType(v string) *ComponentVersion

SetType sets the Type field's value.

func (*ComponentVersion) SetVersion

func (s *ComponentVersion) SetVersion(v string) *ComponentVersion

SetVersion sets the Version field's value.

func (ComponentVersion) String

func (s ComponentVersion) String() string

String returns the string representation

type Container

type Container struct {

	// A list of URIs for containers created in the context Region.
	ImageUris []*string `locationName:"imageUris" type:"list"`

	// Containers and container images are Region-specific. This is the Region context
	// for the container.
	Region *string `locationName:"region" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A container encapsulates the runtime environment for an application.

func (Container) GoString

func (s Container) GoString() string

GoString returns the string representation

func (*Container) SetImageUris

func (s *Container) SetImageUris(v []*string) *Container

SetImageUris sets the ImageUris field's value.

func (*Container) SetRegion

func (s *Container) SetRegion(v string) *Container

SetRegion sets the Region field's value.

func (Container) String

func (s Container) String() string

String returns the string representation

type ContainerDistributionConfiguration

type ContainerDistributionConfiguration struct {

	// Tags that are attached to the container distribution configuration.
	ContainerTags []*string `locationName:"containerTags" type:"list"`

	// The description of the container distribution configuration.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The destination repository for the container distribution configuration.
	//
	// TargetRepository is a required field
	TargetRepository *TargetContainerRepository `locationName:"targetRepository" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (ContainerDistributionConfiguration) GoString

GoString returns the string representation

func (*ContainerDistributionConfiguration) SetContainerTags

SetContainerTags sets the ContainerTags field's value.

func (*ContainerDistributionConfiguration) SetDescription

SetDescription sets the Description field's value.

func (*ContainerDistributionConfiguration) SetTargetRepository

SetTargetRepository sets the TargetRepository field's value.

func (ContainerDistributionConfiguration) String

String returns the string representation

func (*ContainerDistributionConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type ContainerRecipe

type ContainerRecipe struct {

	// The Amazon Resource Name (ARN) of the container recipe.
	Arn *string `locationName:"arn" type:"string"`

	// Components for build and test that are included in the container recipe.
	Components []*ComponentConfiguration `locationName:"components" min:"1" type:"list"`

	// Specifies the type of container, such as Docker.
	ContainerType *string `locationName:"containerType" type:"string" enum:"ContainerType"`

	// The date when this container recipe was created.
	DateCreated *string `locationName:"dateCreated" type:"string"`

	// The description of the container recipe.
	Description *string `locationName:"description" min:"1" type:"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 `locationName:"dockerfileTemplateData" type:"string"`

	// A flag that indicates if the target container is encrypted.
	Encrypted *bool `locationName:"encrypted" type:"boolean"`

	// A group of options that can be used to configure an instance for building
	// and testing container images.
	InstanceConfiguration *InstanceConfiguration `locationName:"instanceConfiguration" type:"structure"`

	// Identifies which KMS key is used to encrypt the container image for distribution
	// to the target Region.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// The name of the container recipe.
	Name *string `locationName:"name" type:"string"`

	// The owner of the container recipe.
	Owner *string `locationName:"owner" min:"1" type:"string"`

	// The source image for the container recipe.
	ParentImage *string `locationName:"parentImage" min:"1" type:"string"`

	// The system platform for the container, such as Windows or Linux.
	Platform *string `locationName:"platform" type:"string" enum:"Platform"`

	// Tags that are attached to the container recipe.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The destination repository for the container image.
	TargetRepository *TargetContainerRepository `locationName:"targetRepository" type:"structure"`

	// The semantic version of the container recipe (<major>.<minor>.<patch>).
	Version *string `locationName:"version" type:"string"`

	// The working directory for use during build and test workflows.
	WorkingDirectory *string `locationName:"workingDirectory" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A container recipe.

func (ContainerRecipe) GoString

func (s ContainerRecipe) GoString() string

GoString returns the string representation

func (*ContainerRecipe) SetArn

func (s *ContainerRecipe) SetArn(v string) *ContainerRecipe

SetArn sets the Arn field's value.

func (*ContainerRecipe) SetComponents

func (s *ContainerRecipe) SetComponents(v []*ComponentConfiguration) *ContainerRecipe

SetComponents sets the Components field's value.

func (*ContainerRecipe) SetContainerType

func (s *ContainerRecipe) SetContainerType(v string) *ContainerRecipe

SetContainerType sets the ContainerType field's value.

func (*ContainerRecipe) SetDateCreated

func (s *ContainerRecipe) SetDateCreated(v string) *ContainerRecipe

SetDateCreated sets the DateCreated field's value.

func (*ContainerRecipe) SetDescription

func (s *ContainerRecipe) SetDescription(v string) *ContainerRecipe

SetDescription sets the Description field's value.

func (*ContainerRecipe) SetDockerfileTemplateData

func (s *ContainerRecipe) SetDockerfileTemplateData(v string) *ContainerRecipe

SetDockerfileTemplateData sets the DockerfileTemplateData field's value.

func (*ContainerRecipe) SetEncrypted

func (s *ContainerRecipe) SetEncrypted(v bool) *ContainerRecipe

SetEncrypted sets the Encrypted field's value.

func (*ContainerRecipe) SetInstanceConfiguration

func (s *ContainerRecipe) SetInstanceConfiguration(v *InstanceConfiguration) *ContainerRecipe

SetInstanceConfiguration sets the InstanceConfiguration field's value.

func (*ContainerRecipe) SetKmsKeyId

func (s *ContainerRecipe) SetKmsKeyId(v string) *ContainerRecipe

SetKmsKeyId sets the KmsKeyId field's value.

func (*ContainerRecipe) SetName

func (s *ContainerRecipe) SetName(v string) *ContainerRecipe

SetName sets the Name field's value.

func (*ContainerRecipe) SetOwner

func (s *ContainerRecipe) SetOwner(v string) *ContainerRecipe

SetOwner sets the Owner field's value.

func (*ContainerRecipe) SetParentImage

func (s *ContainerRecipe) SetParentImage(v string) *ContainerRecipe

SetParentImage sets the ParentImage field's value.

func (*ContainerRecipe) SetPlatform

func (s *ContainerRecipe) SetPlatform(v string) *ContainerRecipe

SetPlatform sets the Platform field's value.

func (*ContainerRecipe) SetTags

func (s *ContainerRecipe) SetTags(v map[string]*string) *ContainerRecipe

SetTags sets the Tags field's value.

func (*ContainerRecipe) SetTargetRepository

func (s *ContainerRecipe) SetTargetRepository(v *TargetContainerRepository) *ContainerRecipe

SetTargetRepository sets the TargetRepository field's value.

func (*ContainerRecipe) SetVersion

func (s *ContainerRecipe) SetVersion(v string) *ContainerRecipe

SetVersion sets the Version field's value.

func (*ContainerRecipe) SetWorkingDirectory

func (s *ContainerRecipe) SetWorkingDirectory(v string) *ContainerRecipe

SetWorkingDirectory sets the WorkingDirectory field's value.

func (ContainerRecipe) String

func (s ContainerRecipe) String() string

String returns the string representation

type ContainerRecipeSummary

type ContainerRecipeSummary struct {

	// The Amazon Resource Name (ARN) of the container recipe.
	Arn *string `locationName:"arn" type:"string"`

	// Specifies the type of container, such as "Docker".
	ContainerType *string `locationName:"containerType" type:"string" enum:"ContainerType"`

	// The date when this container recipe was created.
	DateCreated *string `locationName:"dateCreated" type:"string"`

	// The name of the container recipe.
	Name *string `locationName:"name" type:"string"`

	// The owner of the container recipe.
	Owner *string `locationName:"owner" min:"1" type:"string"`

	// The source image for the container recipe.
	ParentImage *string `locationName:"parentImage" min:"1" type:"string"`

	// The system platform for the container, such as Windows or Linux.
	Platform *string `locationName:"platform" type:"string" enum:"Platform"`

	// Tags that are attached to the container recipe.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

A summary of a container recipe

func (ContainerRecipeSummary) GoString

func (s ContainerRecipeSummary) GoString() string

GoString returns the string representation

func (*ContainerRecipeSummary) SetArn

SetArn sets the Arn field's value.

func (*ContainerRecipeSummary) SetContainerType

func (s *ContainerRecipeSummary) SetContainerType(v string) *ContainerRecipeSummary

SetContainerType sets the ContainerType field's value.

func (*ContainerRecipeSummary) SetDateCreated

SetDateCreated sets the DateCreated field's value.

func (*ContainerRecipeSummary) SetName

SetName sets the Name field's value.

func (*ContainerRecipeSummary) SetOwner

SetOwner sets the Owner field's value.

func (*ContainerRecipeSummary) SetParentImage

SetParentImage sets the ParentImage field's value.

func (*ContainerRecipeSummary) SetPlatform

SetPlatform sets the Platform field's value.

func (*ContainerRecipeSummary) SetTags

SetTags sets the Tags field's value.

func (ContainerRecipeSummary) String

func (s ContainerRecipeSummary) String() string

String returns the string representation

type CreateComponentInput

type CreateComponentInput struct {

	// The change description of the component. Describes what change has been made
	// in this version, or what makes this version different from other versions
	// of this component.
	ChangeDescription *string `locationName:"changeDescription" min:"1" type:"string"`

	// The idempotency token of the component.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The data of the component. Used to specify the data inline. Either data or
	// uri can be used to specify the data within the component.
	Data *string `locationName:"data" min:"1" type:"string"`

	// The description of the component. Describes the contents of the component.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the KMS key that should be used to encrypt this component.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// The name of the component.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The platform of the component.
	//
	// Platform is a required field
	Platform *string `locationName:"platform" type:"string" required:"true" enum:"Platform"`

	// The semantic version of the component. This version follows the semantic
	// version syntax. For example, major.minor.patch. This could be versioned like
	// software (2.0.1) or like a date (2019.12.01).
	//
	// SemanticVersion is a required field
	SemanticVersion *string `locationName:"semanticVersion" type:"string" required:"true"`

	// 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 `locationName:"supportedOsVersions" min:"1" type:"list"`

	// The tags of the component.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

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

func (CreateComponentInput) GoString

func (s CreateComponentInput) GoString() string

GoString returns the string representation

func (*CreateComponentInput) SetChangeDescription

func (s *CreateComponentInput) SetChangeDescription(v string) *CreateComponentInput

SetChangeDescription sets the ChangeDescription field's value.

func (*CreateComponentInput) SetClientToken

func (s *CreateComponentInput) SetClientToken(v string) *CreateComponentInput

SetClientToken sets the ClientToken field's value.

func (*CreateComponentInput) SetData

SetData sets the Data field's value.

func (*CreateComponentInput) SetDescription

func (s *CreateComponentInput) SetDescription(v string) *CreateComponentInput

SetDescription sets the Description field's value.

func (*CreateComponentInput) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateComponentInput) SetName

SetName sets the Name field's value.

func (*CreateComponentInput) SetPlatform

SetPlatform sets the Platform field's value.

func (*CreateComponentInput) SetSemanticVersion

func (s *CreateComponentInput) SetSemanticVersion(v string) *CreateComponentInput

SetSemanticVersion sets the SemanticVersion field's value.

func (*CreateComponentInput) SetSupportedOsVersions

func (s *CreateComponentInput) SetSupportedOsVersions(v []*string) *CreateComponentInput

SetSupportedOsVersions sets the SupportedOsVersions field's value.

func (*CreateComponentInput) SetTags

SetTags sets the Tags field's value.

func (*CreateComponentInput) SetUri

SetUri sets the Uri field's value.

func (CreateComponentInput) String

func (s CreateComponentInput) String() string

String returns the string representation

func (*CreateComponentInput) Validate

func (s *CreateComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComponentOutput

type CreateComponentOutput struct {

	// The idempotency token used to make this request idempotent.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the component that was created by this
	// request.
	ComponentBuildVersionArn *string `locationName:"componentBuildVersionArn" type:"string"`

	// The request ID that uniquely identifies this request.
	RequestId *string `locationName:"requestId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateComponentOutput) GoString

func (s CreateComponentOutput) GoString() string

GoString returns the string representation

func (*CreateComponentOutput) SetClientToken

func (s *CreateComponentOutput) SetClientToken(v string) *CreateComponentOutput

SetClientToken sets the ClientToken field's value.

func (*CreateComponentOutput) SetComponentBuildVersionArn

func (s *CreateComponentOutput) SetComponentBuildVersionArn(v string) *CreateComponentOutput

SetComponentBuildVersionArn sets the ComponentBuildVersionArn field's value.

func (*CreateComponentOutput) SetRequestId

SetRequestId sets the RequestId field's value.

func (CreateComponentOutput) String

func (s CreateComponentOutput) String() string

String returns the string representation

type CreateContainerRecipeInput

type CreateContainerRecipeInput struct {

	// The client token used to make this request idempotent.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// Components for build and test that are included in the container recipe.
	//
	// Components is a required field
	Components []*ComponentConfiguration `locationName:"components" min:"1" type:"list" required:"true"`

	// The type of container to create.
	//
	// ContainerType is a required field
	ContainerType *string `locationName:"containerType" type:"string" required:"true" enum:"ContainerType"`

	// The description of the container recipe.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The Dockerfile template used to build your image as an inline data blob.
	DockerfileTemplateData *string `locationName:"dockerfileTemplateData" min:"1" type:"string"`

	// The S3 URI for the Dockerfile that will be used to build your container image.
	DockerfileTemplateUri *string `locationName:"dockerfileTemplateUri" type:"string"`

	// Specifies the operating system version for the source image.
	ImageOsVersionOverride *string `locationName:"imageOsVersionOverride" min:"1" type:"string"`

	// A group of options that can be used to configure an instance for building
	// and testing container images.
	InstanceConfiguration *InstanceConfiguration `locationName:"instanceConfiguration" type:"structure"`

	// Identifies which KMS key is used to encrypt the container image.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`

	// The name of the container recipe.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The source image for the container recipe.
	//
	// ParentImage is a required field
	ParentImage *string `locationName:"parentImage" min:"1" type:"string" required:"true"`

	// Specifies the operating system platform when you use a custom source image.
	PlatformOverride *string `locationName:"platformOverride" type:"string" enum:"Platform"`

	// The semantic version of the container recipe (<major>.<minor>.<patch>).
	//
	// SemanticVersion is a required field
	SemanticVersion *string `locationName:"semanticVersion" type:"string" required:"true"`

	// Tags that are attached to the container recipe.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The destination repository for the container image.
	//
	// TargetRepository is a required field
	TargetRepository *TargetContainerRepository `locationName:"targetRepository" type:"structure" required:"true"`

	// The working directory for use during build and test workflows.
	WorkingDirectory *string `locationName:"workingDirectory" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateContainerRecipeInput) GoString

func (s CreateContainerRecipeInput) GoString() string

GoString returns the string representation

func (*CreateContainerRecipeInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateContainerRecipeInput) SetComponents