interface SecretProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.CfnTaskDefinition.SecretProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#CfnTaskDefinition_SecretProperty |
![]() | software.amazon.awscdk.services.ecs.CfnTaskDefinition.SecretProperty |
![]() | aws_cdk.aws_ecs.CfnTaskDefinition.SecretProperty |
![]() | aws-cdk-lib » aws_ecs » CfnTaskDefinition » SecretProperty |
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 { aws_ecs as ecs } from 'aws-cdk-lib';
const secretProperty: ecs.CfnTaskDefinition.SecretProperty = {
name: 'name',
valueFrom: 'valueFrom',
};
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the secret. |
value | string | The secret to expose to the container. |
name
Type:
string
The name of the secret.
valueFrom
Type:
string
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.