Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.SecretProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.SecretProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

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

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

For more information, see Specifying sensitive data in the AWS Batch User 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.batch.*;
 SecretProperty secretProperty = SecretProperty.builder()
         .name("name")
         .valueFrom("valueFrom")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.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.

See Also:

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

getValueFrom

@Stability(Stable)
@NotNull
String getValueFrom()

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.

See Also:

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

builder

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

Returns:

a CfnJobDefinition.SecretProperty.Builder of CfnJobDefinition.SecretProperty