software.amazon.awscdk.services.batch

Class ExposedSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.ExposedSecret

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:10.935Z")
public class ExposedSecret
extends software.amazon.jsii.JsiiObject

(experimental) Exposed secret for log configuration.

Example:

 import software.amazon.awscdk.services.ssm.*;
 JobDefinition.Builder.create(this, "job-def")
         .container(JobDefinitionContainer.builder()
                 .image(EcrImage.fromRegistry("docker/whalesay"))
                 .logConfiguration(LogConfiguration.builder()
                         .logDriver(LogDriver.AWSLOGS)
                         .options(Map.of("awslogs-region", "us-east-1"))
                         .secretOptions(List.of(ExposedSecret.fromParametersStore("xyz", StringParameter.fromStringParameterName(this, "parameter", "xyz"))))
                         .build())
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExposedSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ExposedSecret(software.amazon.jsii.JsiiObjectRef objRef)
	ExposedSecret(java.lang.String optionName, java.lang.String secretArn)

Method Summary

Modifier and Type	Method and Description
static ExposedSecret	fromParametersStore(java.lang.String optionName, IParameter parameter) (experimental) User Parameters Store Parameter.
static ExposedSecret	fromSecretsManager(java.lang.String optionName, ISecret secret) (experimental) Use Secrets Manager Secret.
java.lang.String	getOptionName() (experimental) Name of the option.
java.lang.String	getSecretArn() (experimental) ARN of the secret option.
void	setOptionName(java.lang.String value) (experimental) Name of the option.
void	setSecretArn(java.lang.String value) (experimental) ARN of the secret option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExposedSecret

protected ExposedSecret(software.amazon.jsii.JsiiObjectRef objRef)

ExposedSecret

protected ExposedSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ExposedSecret

public ExposedSecret(java.lang.String optionName,
                     java.lang.String secretArn)

Parameters:

optionName - This parameter is required.

secretArn - This parameter is required.

Method Detail

fromParametersStore

public static ExposedSecret fromParametersStore(java.lang.String optionName,
                                                IParameter parameter)

(experimental) User Parameters Store Parameter.

Parameters:

optionName - - The name of the option. This parameter is required.

parameter - - A parameter from parameters store. This parameter is required.

fromSecretsManager

public static ExposedSecret fromSecretsManager(java.lang.String optionName,
                                               ISecret secret)

(experimental) Use Secrets Manager Secret.

Parameters:

optionName - - The name of the option. This parameter is required.

secret - - A secret from secrets manager. This parameter is required.

getOptionName

public java.lang.String getOptionName()

(experimental) Name of the option.

setOptionName

public void setOptionName(java.lang.String value)

(experimental) Name of the option.

getSecretArn

public java.lang.String getSecretArn()

(experimental) ARN of the secret option.

setSecretArn

public void setSecretArn(java.lang.String value)

(experimental) ARN of the secret option.