awsecrassets

Documentation

Index

• func DockerImageAsset_IsConstruct(x interface{}) *bool
• func NewDockerImageAsset_Override(d DockerImageAsset, scope constructs.Construct, id *string, ...)
• func NewTarballImageAsset_Override(t TarballImageAsset, scope constructs.Construct, id *string, ...)
• func TarballImageAsset_IsConstruct(x interface{}) *bool
• type DockerImageAsset
  • func NewDockerImageAsset(scope constructs.Construct, id *string, props *DockerImageAssetProps) DockerImageAsset
• type DockerImageAssetInvalidationOptions
• type DockerImageAssetOptions
• type DockerImageAssetProps
• type TarballImageAsset
  • func NewTarballImageAsset(scope constructs.Construct, id *string, props *TarballImageAssetProps) TarballImageAsset
• type TarballImageAssetProps

Functions

func DockerImageAsset_IsConstruct

func DockerImageAsset_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewDockerImageAsset_Override

func NewDockerImageAsset_Override(d DockerImageAsset, scope constructs.Construct, id *string, props *DockerImageAssetProps)

Experimental.

func NewTarballImageAsset_Override

func NewTarballImageAsset_Override(t TarballImageAsset, scope constructs.Construct, id *string, props *TarballImageAssetProps)

Experimental.

func TarballImageAsset_IsConstruct

func TarballImageAsset_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

Types

type DockerImageAsset

type DockerImageAsset interface {
	awscdk.Construct
	assets.IAsset
	AssetHash() *string
	ImageUri() *string
	SetImageUri(val *string)
	Node() awscdk.ConstructNode
	Repository() awsecr.IRepository
	SetRepository(val awsecr.IRepository)
	SourceHash() *string
	AddResourceMetadata(resource awscdk.CfnResource, resourceProperty *string)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An asset that represents a Docker image.

The image will be created in build time and uploaded to an ECR repository.

TODO: EXAMPLE

Experimental.

func NewDockerImageAsset

func NewDockerImageAsset(scope constructs.Construct, id *string, props *DockerImageAssetProps) DockerImageAsset

Experimental.

type DockerImageAssetInvalidationOptions

type DockerImageAssetInvalidationOptions struct {
	// Use `buildArgs` while calculating the asset hash.
	// Experimental.
	BuildArgs *bool `json:"buildArgs"`
	// Use `extraHash` while calculating the asset hash.
	// Experimental.
	ExtraHash *bool `json:"extraHash"`
	// Use `file` while calculating the asset hash.
	// Experimental.
	File *bool `json:"file"`
	// Use `repositoryName` while calculating the asset hash.
	// Experimental.
	RepositoryName *bool `json:"repositoryName"`
	// Use `target` while calculating the asset hash.
	// Experimental.
	Target *bool `json:"target"`
}

Options to control invalidation of `DockerImageAsset` asset hashes.

TODO: EXAMPLE

Experimental.

type DockerImageAssetOptions

type DockerImageAssetOptions struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude"`
	// A strategy for how to handle symlinks.
	// Deprecated: use `followSymlinks` instead
	Follow assets.FollowMode `json:"follow"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode awscdk.IgnoreMode `json:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	// Experimental.
	ExtraHash *string `json:"extraHash"`
	// A strategy for how to handle symlinks.
	// Experimental.
	FollowSymlinks awscdk.SymlinkFollowMode `json:"followSymlinks"`
	// Build args to pass to the `docker build` command.
	//
	// Since Docker build arguments are resolved before deployment, keys and
	// values cannot refer to unresolved tokens (such as `lambda.functionArn` or
	// `queue.queueUrl`).
	// Experimental.
	BuildArgs *map[string]*string `json:"buildArgs"`
	// Path to the Dockerfile (relative to the directory).
	// Experimental.
	File *string `json:"file"`
	// Options to control which parameters are used to invalidate the asset hash.
	// Experimental.
	Invalidation *DockerImageAssetInvalidationOptions `json:"invalidation"`
	// ECR repository name.
	//
	// Specify this property if you need to statically address the image, e.g.
	// from a Kubernetes Pod. Note, this is only the repository name, without the
	// registry and the tag parts.
	// Deprecated: to control the location of docker image assets, please override
	// `Stack.addDockerImageAsset`. this feature will be removed in future
	// releases.
	RepositoryName *string `json:"repositoryName"`
	// Docker target to build to.
	// Experimental.
	Target *string `json:"target"`
}

Options for DockerImageAsset.

TODO: EXAMPLE

Experimental.

type DockerImageAssetProps

type DockerImageAssetProps struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude"`
	// A strategy for how to handle symlinks.
	// Deprecated: use `followSymlinks` instead
	Follow assets.FollowMode `json:"follow"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode awscdk.IgnoreMode `json:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	// Experimental.
	ExtraHash *string `json:"extraHash"`
	// A strategy for how to handle symlinks.
	// Experimental.
	FollowSymlinks awscdk.SymlinkFollowMode `json:"followSymlinks"`
	// Build args to pass to the `docker build` command.
	//
	// Since Docker build arguments are resolved before deployment, keys and
	// values cannot refer to unresolved tokens (such as `lambda.functionArn` or
	// `queue.queueUrl`).
	// Experimental.
	BuildArgs *map[string]*string `json:"buildArgs"`
	// Path to the Dockerfile (relative to the directory).
	// Experimental.
	File *string `json:"file"`
	// Options to control which parameters are used to invalidate the asset hash.
	// Experimental.
	Invalidation *DockerImageAssetInvalidationOptions `json:"invalidation"`
	// ECR repository name.
	//
	// Specify this property if you need to statically address the image, e.g.
	// from a Kubernetes Pod. Note, this is only the repository name, without the
	// registry and the tag parts.
	// Deprecated: to control the location of docker image assets, please override
	// `Stack.addDockerImageAsset`. this feature will be removed in future
	// releases.
	RepositoryName *string `json:"repositoryName"`
	// Docker target to build to.
	// Experimental.
	Target *string `json:"target"`
	// The directory where the Dockerfile is stored.
	//
	// Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset
	// Experimental.
	Directory *string `json:"directory"`
}

Props for DockerImageAssets.

TODO: EXAMPLE

Experimental.

type TarballImageAsset

type TarballImageAsset interface {
	awscdk.Construct
	assets.IAsset
	AssetHash() *string
	ImageUri() *string
	SetImageUri(val *string)
	Node() awscdk.ConstructNode
	Repository() awsecr.IRepository
	SetRepository(val awsecr.IRepository)
	SourceHash() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An asset that represents a Docker image.

The image will loaded from an existing tarball and uploaded to an ECR repository.

TODO: EXAMPLE

Experimental.

func NewTarballImageAsset

func NewTarballImageAsset(scope constructs.Construct, id *string, props *TarballImageAssetProps) TarballImageAsset

Experimental.

type TarballImageAssetProps

type TarballImageAssetProps struct {
	// Absolute path to the tarball.
	//
	// It is recommended to to use the script running directory (e.g. `__dirname`
	// in Node.js projects or dirname of `__file__` in Python) if your tarball
	// is located as a resource inside your project.
	// Experimental.
	TarballFile *string `json:"tarballFile"`
}

Options for TarballImageAsset.

TODO: EXAMPLE

Experimental.