Class: AWSCDK::ECS::CfnService::SecretProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnService::SecretProperty

Defined in:

ecs/cfn_service.rb

Overview

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 secret_options container definition parameter.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the secret.

• #value_from ⇒ String readonly

  The secret to expose to the container.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, value_from:) ⇒ SecretProperty constructor

  A new instance of SecretProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, value_from:) ⇒ SecretProperty

Returns a new instance of SecretProperty.

Parameters:

• name (String) —

  The name of the secret.

• value_from (String) —

  The secret to expose to the container.

# File 'ecs/cfn_service.rb', line 2356

def initialize(name:, value_from:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @value_from = value_from
  Jsii::Type.check_type(@value_from, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "valueFrom")
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the secret.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html#cfn-ecs-service-secret-name

# File 'ecs/cfn_service.rb', line 2367

def name
  @name
end

#value_from ⇒ String (readonly)

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.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html#cfn-ecs-service-secret-valuefrom

# File 'ecs/cfn_service.rb', line 2378

def value_from
  @value_from
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_service.rb', line 2380

def self.jsii_properties
  {
    :name => "name",
    :value_from => "valueFrom",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_service.rb', line 2387

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "valueFrom" => @value_from,
  })
  result.compact
end