DockerImageAsset Struct
A file asset.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
declare const assumeRoleAdditionalOptions: any;
const dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {
destinations: {
destinationsKey: {
imageTag: 'imageTag',
repositoryName: 'repositoryName',
// the properties below are optional
assumeRoleAdditionalOptions: {
assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
},
assumeRoleArn: 'assumeRoleArn',
assumeRoleExternalId: 'assumeRoleExternalId',
region: 'region',
},
},
source: {
cacheDisabled: false,
cacheFrom: [{
type: 'type',
// the properties below are optional
params: {
paramsKey: 'params',
},
}],
cacheTo: {
type: 'type',
// the properties below are optional
params: {
paramsKey: 'params',
},
},
directory: 'directory',
dockerBuildArgs: {
dockerBuildArgsKey: 'dockerBuildArgs',
},
dockerBuildContexts: {
dockerBuildContextsKey: 'dockerBuildContexts',
},
dockerBuildSecrets: {
dockerBuildSecretsKey: 'dockerBuildSecrets',
},
dockerBuildSsh: 'dockerBuildSsh',
dockerBuildTarget: 'dockerBuildTarget',
dockerFile: 'dockerFile',
dockerOutputs: ['dockerOutputs'],
executable: ['executable'],
networkMode: 'networkMode',
platform: 'platform',
},
// the properties below are optional
displayName: 'displayName',
};
python
from aws_cdk.cloud_assembly_schema import DockerImageAsset, DockerImageDestination, DockerImageSource, DockerCacheOption, DockerCacheOption
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema
# assume_role_additional_options: Any
docker_image_asset = DockerImageAsset(
destinations={
"destinations_key": DockerImageDestination(
image_tag="imageTag",
repository_name="repositoryName",
# the properties below are optional
assume_role_additional_options={
"assume_role_additional_options_key": assume_role_additional_options
},
assume_role_arn="assumeRoleArn",
assume_role_external_id="assumeRoleExternalId",
region="region"
)
},
source=DockerImageSource(
cache_disabled=False,
cache_from=[DockerCacheOption(
type="type",
# the properties below are optional
params={
"params_key": "params"
}
)],
cache_to=DockerCacheOption(
type="type",
# the properties below are optional
params={
"params_key": "params"
}
),
directory="directory",
docker_build_args={
"docker_build_args_key": "dockerBuildArgs"
},
docker_build_contexts={
"docker_build_contexts_key": "dockerBuildContexts"
},
docker_build_secrets={
"docker_build_secrets_key": "dockerBuildSecrets"
},
docker_build_ssh="dockerBuildSsh",
docker_build_target="dockerBuildTarget",
docker_file="dockerFile",
docker_outputs=["dockerOutputs"],
executable=["executable"],
network_mode="networkMode",
platform="platform"
),
# the properties below are optional
display_name="displayName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;
Object assumeRoleAdditionalOptions;
DockerImageAsset dockerImageAsset = DockerImageAsset.builder()
.destinations(Map.of(
"destinationsKey", DockerImageDestination.builder()
.imageTag("imageTag")
.repositoryName("repositoryName")
// the properties below are optional
.assumeRoleAdditionalOptions(Map.of(
"assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
.assumeRoleArn("assumeRoleArn")
.assumeRoleExternalId("assumeRoleExternalId")
.region("region")
.build()))
.source(DockerImageSource.builder()
.cacheDisabled(false)
.cacheFrom(List.of(DockerCacheOption.builder()
.type("type")
// the properties below are optional
.params(Map.of(
"paramsKey", "params"))
.build()))
.cacheTo(DockerCacheOption.builder()
.type("type")
// the properties below are optional
.params(Map.of(
"paramsKey", "params"))
.build())
.directory("directory")
.dockerBuildArgs(Map.of(
"dockerBuildArgsKey", "dockerBuildArgs"))
.dockerBuildContexts(Map.of(
"dockerBuildContextsKey", "dockerBuildContexts"))
.dockerBuildSecrets(Map.of(
"dockerBuildSecretsKey", "dockerBuildSecrets"))
.dockerBuildSsh("dockerBuildSsh")
.dockerBuildTarget("dockerBuildTarget")
.dockerFile("dockerFile")
.dockerOutputs(List.of("dockerOutputs"))
.executable(List.of("executable"))
.networkMode("networkMode")
.platform("platform")
.build())
// the properties below are optional
.displayName("displayName")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;
var assumeRoleAdditionalOptions;
var dockerImageAsset = new DockerImageAsset {
Destinations = new Dictionary<string, DockerImageDestination> {
{ "destinationsKey", new DockerImageDestination {
ImageTag = "imageTag",
RepositoryName = "repositoryName",
// the properties below are optional
AssumeRoleAdditionalOptions = new Dictionary<string, object> {
{ "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
},
AssumeRoleArn = "assumeRoleArn",
AssumeRoleExternalId = "assumeRoleExternalId",
Region = "region"
} }
},
Source = new DockerImageSource {
CacheDisabled = false,
CacheFrom = new [] { new DockerCacheOption {
Type = "type",
// the properties below are optional
Params = new Dictionary<string, string> {
{ "paramsKey", "params" }
}
} },
CacheTo = new DockerCacheOption {
Type = "type",
// the properties below are optional
Params = new Dictionary<string, string> {
{ "paramsKey", "params" }
}
},
Directory = "directory",
DockerBuildArgs = new Dictionary<string, string> {
{ "dockerBuildArgsKey", "dockerBuildArgs" }
},
DockerBuildContexts = new Dictionary<string, string> {
{ "dockerBuildContextsKey", "dockerBuildContexts" }
},
DockerBuildSecrets = new Dictionary<string, string> {
{ "dockerBuildSecretsKey", "dockerBuildSecrets" }
},
DockerBuildSsh = "dockerBuildSsh",
DockerBuildTarget = "dockerBuildTarget",
DockerFile = "dockerFile",
DockerOutputs = new [] { "dockerOutputs" },
Executable = new [] { "executable" },
NetworkMode = "networkMode",
Platform = "platform"
},
// the properties below are optional
DisplayName = "displayName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
dockerImageAsset := &DockerImageAsset{
Destinations: map[string]DockerImageDestination{
"destinationsKey": &DockerImageDestination{
"imageTag": jsii.String("imageTag"),
"repositoryName": jsii.String("repositoryName"),
// the properties below are optional
"assumeRoleAdditionalOptions": map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
"assumeRoleArn": jsii.String("assumeRoleArn"),
"assumeRoleExternalId": jsii.String("assumeRoleExternalId"),
"region": jsii.String("region"),
},
},
Source: &DockerImageSource{
CacheDisabled: jsii.Boolean(false),
CacheFrom: []DockerCacheOption{
&DockerCacheOption{
Type: jsii.String("type"),
// the properties below are optional
Params: map[string]*string{
"paramsKey": jsii.String("params"),
},
},
},
CacheTo: &DockerCacheOption{
Type: jsii.String("type"),
// the properties below are optional
Params: map[string]*string{
"paramsKey": jsii.String("params"),
},
},
Directory: jsii.String("directory"),
DockerBuildArgs: map[string]*string{
"dockerBuildArgsKey": jsii.String("dockerBuildArgs"),
},
DockerBuildContexts: map[string]*string{
"dockerBuildContextsKey": jsii.String("dockerBuildContexts"),
},
DockerBuildSecrets: map[string]*string{
"dockerBuildSecretsKey": jsii.String("dockerBuildSecrets"),
},
DockerBuildSsh: jsii.String("dockerBuildSsh"),
DockerBuildTarget: jsii.String("dockerBuildTarget"),
DockerFile: jsii.String("dockerFile"),
DockerOutputs: []*string{
jsii.String("dockerOutputs"),
},
Executable: []*string{
jsii.String("executable"),
},
NetworkMode: jsii.String("networkMode"),
Platform: jsii.String("platform"),
},
// the properties below are optional
DisplayName: jsii.String("displayName"),
}
Properties
destinations{ [key: string]: DockerImageDestination }destinationstyping.Mapping[str, DockerImageDestination]destinationsMap<String, DockerImageDestination>DestinationsIDictionary<string, DockerImageDestination>Destinations*map[string]DockerImageDestinationrequired#Destinations for this container asset.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#A display name for this asset.
Default: The identifier will be used as the display name
sourceDockerImageSourcesourceDockerImageSourcesourceDockerImageSourceSourceDockerImageSourceSourceDockerImageSourcerequired#Source description for container assets.