AWS CDK Reference

Appearance

v2.273.0

DomainJoinedCredentialSpec Class ​

Credential specification (CredSpec) file.

Source
aws-ecs/lib/credential-spec.ts
Type last changed
v2.129.0 · 21 Feb 2024

Example ​

ts
// Make sure the task definition's execution role has permissions to read from the S3 bucket or SSM parameter where the CredSpec file is stored.
declare const parameter: ssm.IParameter;
declare const taskDefinition: ecs.TaskDefinition;

// Domain-joined gMSA container from a SSM parameter
taskDefinition.addContainer('gmsa-domain-joined-container', {
  image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  cpu: 128,
  memoryLimitMiB: 256,
  credentialSpecs: [ecs.DomainJoinedCredentialSpec.fromSsmParameter(parameter)],
});
python
# Make sure the task definition's execution role has permissions to read from the S3 bucket or SSM parameter where the CredSpec file is stored.
# parameter: ssm.IParameter
# task_definition: ecs.TaskDefinition


# Domain-joined gMSA container from a SSM parameter
task_definition.add_container("gmsa-domain-joined-container",
    image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample"),
    cpu=128,
    memory_limit_mi_b=256,
    credential_specs=[ecs.DomainJoinedCredentialSpec.from_ssm_parameter(parameter)]
)
java
// Make sure the task definition's execution role has permissions to read from the S3 bucket or SSM parameter where the CredSpec file is stored.
IParameter parameter;
TaskDefinition taskDefinition;


// Domain-joined gMSA container from a SSM parameter
taskDefinition.addContainer("gmsa-domain-joined-container", ContainerDefinitionOptions.builder()
        .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
        .cpu(128)
        .memoryLimitMiB(256)
        .credentialSpecs(List.of(DomainJoinedCredentialSpec.fromSsmParameter(parameter)))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Make sure the task definition's execution role has permissions to read from the S3 bucket or SSM parameter where the CredSpec file is stored.
IParameter parameter;
TaskDefinition taskDefinition;


// Domain-joined gMSA container from a SSM parameter
taskDefinition.AddContainer("gmsa-domain-joined-container", new ContainerDefinitionOptions {
    Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
    Cpu = 128,
    MemoryLimitMiB = 256,
    CredentialSpecs = new [] { DomainJoinedCredentialSpec.FromSsmParameter(parameter) }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Make sure the task definition's execution role has permissions to read from the S3 bucket or SSM parameter where the CredSpec file is stored.
var parameter IParameter
var taskDefinition TaskDefinition


// Domain-joined gMSA container from a SSM parameter
taskDefinition.AddContainer(jsii.String("gmsa-domain-joined-container"), &ContainerDefinitionOptions{
	Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
	Cpu: jsii.Number(128),
	MemoryLimitMiB: jsii.Number(256),
	CredentialSpecs: []CredentialSpec{
		ecs.DomainJoinedCredentialSpec_FromSsmParameter(parameter),
	},
})

Initializer ​

ts
new DomainJoinedCredentialSpec(fileLocation: string)
python
DomainJoinedCredentialSpec(file_location: str)
java
new DomainJoinedCredentialSpec(String fileLocation)
csharp
new DomainJoinedCredentialSpec(string fileLocation)
go
NewDomainJoinedCredentialSpec(FileLocation *string)

Properties ​

fileLocationstringfile_locationstrfileLocationStringFileLocationstringFileLocation*stringrequired#
Location or ARN from where to retrieve the CredSpec file.
prefixIdstringprefix_idstrprefixIdStringPrefixIdstringPrefixId*stringrequired#
Prefix string based on the type of CredSpec.

Methods ​

bind(): CredentialSpecConfigdef bind(self, ) -> CredentialSpecConfigpublic CredentialSpecConfig bind()public CredentialSpecConfig Bind()func Bind() CredentialSpecConfig#
Called when the container is initialized to allow this object to bind to the stack.
fromS3Bucket(bucket: IBucket, key: string): DomainJoinedCredentialSpec // chainable@staticmethod def from_s3_bucket(bucket: IBucket, key: str) -> DomainJoinedCredentialSpecpublic static DomainJoinedCredentialSpec fromS3Bucket(IBucket bucket, String key)public static DomainJoinedCredentialSpec FromS3Bucket(IBucket bucket, string key)func FromS3Bucket(Bucket IBucket, Key *string) DomainJoinedCredentialSpecstatic#
Loads the CredSpec from a S3 bucket object.
2 parameters · returns

Parameters

  • bucketbucketbucketbucketBucket — The S3 bucket.
  • keykeykeykeyKey — The object key.

Returns: CredSpec with it's locations set to the S3 object's ARN.

fromSsmParameter(parameter: IParameter): DomainJoinedCredentialSpec // chainable@staticmethod def from_ssm_parameter(parameter: IParameter) -> DomainJoinedCredentialSpecpublic static DomainJoinedCredentialSpec fromSsmParameter(IParameter parameter)public static DomainJoinedCredentialSpec FromSsmParameter(IParameter parameter)func FromSsmParameter(Parameter IParameter) DomainJoinedCredentialSpecstatic#
Loads the CredSpec from a SSM parameter.
1 parameter · returns

Parameters

  • parameterparameterparameterparameterParameter — The SSM parameter.

Returns: CredSpec with it's locations set to the SSM parameter's ARN.