Package software.amazon.awscdk.services.ecs

Interface CfnService.SecretProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.SecretProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.SecretProperty
extends software.amazon.jsii.JsiiSerializable

An object representing the secret to expose to your container.

Secrets can be exposed to a container in the following ways:

• To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
• To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 SecretProperty secretProperty = SecretProperty.builder()
         .name("name")
         .valueFrom("valueFrom")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.SecretProperty.Builder	A builder for CfnService.SecretProperty
static final class	CfnService.SecretProperty.Jsii$Proxy	An implementation for CfnService.SecretProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.SecretProperty.Builder	builder()
String	getName()	The name of the secret.
String	getValueFrom()	The secret to expose to the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the secret.

getValueFrom

@Stability(Stable)
@NotNull
String getValueFrom()

The secret to expose to the container.

The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require AWS Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide .

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

builder

@Stability(Stable)
static CfnService.SecretProperty.Builder builder()

Returns:

a CfnService.SecretProperty.Builder of CfnService.SecretProperty