Class: AWSCDK::Batch::CfnJobDefinition::SecretProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Batch::CfnJobDefinition::SecretProperty

Defined in:

batch/cfn_job_definition.rb

Overview

An object that represents 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 AWS Batch User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-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 'batch/cfn_job_definition.rb', line 3407

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-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-name

# File 'batch/cfn_job_definition.rb', line 3418

def name
  @name
end

#value_from ⇒ String (readonly)

The secret to expose to the container.

The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (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-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-valuefrom

# File 'batch/cfn_job_definition.rb', line 3427

def value_from
  @value_from
end

Class Method Details

.jsii_properties ⇒ Object

# File 'batch/cfn_job_definition.rb', line 3429

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

Instance Method Details

#to_jsii ⇒ Object

# File 'batch/cfn_job_definition.rb', line 3436

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