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 NetworkMode
  • func NetworkMode_Custom(mode *string) NetworkMode
  • func NetworkMode_DEFAULT() NetworkMode
  • func NetworkMode_FromContainer(containerId *string) NetworkMode
  • func NetworkMode_HOST() NetworkMode
  • func NetworkMode_NONE() NetworkMode
• type TarballImageAsset
  • func NewTarballImageAsset(scope constructs.Construct, id *string, props *TarballImageAssetProps) TarballImageAsset
• type TarballImageAssetProps

Functions

func DockerImageAsset_IsConstruct

func DockerImageAsset_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewDockerImageAsset_Override

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

func NewTarballImageAsset_Override

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

func TarballImageAsset_IsConstruct

func TarballImageAsset_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

Types

type DockerImageAsset

type DockerImageAsset interface {
	constructs.Construct
	AssetHash() *string
	ImageUri() *string
	SetImageUri(val *string)
	Node() constructs.Node
	Repository() awsecr.IRepository
	SetRepository(val awsecr.IRepository)
	AddResourceMetadata(resource awscdk.CfnResource, resourceProperty *string)
	ToString() *string
}

An asset that represents a Docker image.

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

TODO: EXAMPLE

func NewDockerImageAsset

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

type DockerImageAssetInvalidationOptions

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

Options to control invalidation of `DockerImageAsset` asset hashes.

TODO: EXAMPLE

type DockerImageAssetOptions

type DockerImageAssetOptions struct {
	// Glob patterns to exclude from the copy.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	FollowSymlinks awscdk.SymlinkFollowMode `json:"followSymlinks" yaml:"followSymlinks"`
	// The ignore behavior to use for exclude patterns.
	IgnoreMode awscdk.IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	ExtraHash *string `json:"extraHash" yaml:"extraHash"`
	// 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`).
	BuildArgs *map[string]*string `json:"buildArgs" yaml:"buildArgs"`
	// Path to the Dockerfile (relative to the directory).
	File *string `json:"file" yaml:"file"`
	// Options to control which parameters are used to invalidate the asset hash.
	Invalidation *DockerImageAssetInvalidationOptions `json:"invalidation" yaml:"invalidation"`
	// Networking mode for the RUN commands during build.
	//
	// Support docker API 1.25+.
	NetworkMode NetworkMode `json:"networkMode" yaml:"networkMode"`
	// Docker target to build to.
	Target *string `json:"target" yaml:"target"`
}

Options for DockerImageAsset.

TODO: EXAMPLE

type DockerImageAssetProps

type DockerImageAssetProps struct {
	// Glob patterns to exclude from the copy.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	FollowSymlinks awscdk.SymlinkFollowMode `json:"followSymlinks" yaml:"followSymlinks"`
	// The ignore behavior to use for exclude patterns.
	IgnoreMode awscdk.IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	ExtraHash *string `json:"extraHash" yaml:"extraHash"`
	// 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`).
	BuildArgs *map[string]*string `json:"buildArgs" yaml:"buildArgs"`
	// Path to the Dockerfile (relative to the directory).
	File *string `json:"file" yaml:"file"`
	// Options to control which parameters are used to invalidate the asset hash.
	Invalidation *DockerImageAssetInvalidationOptions `json:"invalidation" yaml:"invalidation"`
	// Networking mode for the RUN commands during build.
	//
	// Support docker API 1.25+.
	NetworkMode NetworkMode `json:"networkMode" yaml:"networkMode"`
	// Docker target to build to.
	Target *string `json:"target" yaml:"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
	Directory *string `json:"directory" yaml:"directory"`
}

Props for DockerImageAssets.

TODO: EXAMPLE

type NetworkMode

type NetworkMode interface {
	Mode() *string
}

networking mode on build time supported by docker.

TODO: EXAMPLE

func NetworkMode_Custom

func NetworkMode_Custom(mode *string) NetworkMode

Used to specify a custom networking mode Use this if the networking mode name is not yet supported by the CDK.

func NetworkMode_DEFAULT

func NetworkMode_DEFAULT() NetworkMode

func NetworkMode_FromContainer

func NetworkMode_FromContainer(containerId *string) NetworkMode

Reuse another container's network stack.

func NetworkMode_HOST

func NetworkMode_HOST() NetworkMode

func NetworkMode_NONE

func NetworkMode_NONE() NetworkMode

type TarballImageAsset

type TarballImageAsset interface {
	constructs.Construct
	AssetHash() *string
	ImageUri() *string
	SetImageUri(val *string)
	Node() constructs.Node
	Repository() awsecr.IRepository
	SetRepository(val awsecr.IRepository)
	ToString() *string
}

An asset that represents a Docker image.

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

TODO: EXAMPLE

func NewTarballImageAsset

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

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.
	TarballFile *string `json:"tarballFile" yaml:"tarballFile"`
}

Options for TarballImageAsset.

TODO: EXAMPLE