software.amazon.awscdk.services.batch

Class ExposedSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.ExposedSecret

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:01.635Z")
 @Stability(value=Experimental)
public class ExposedSecret
extends software.amazon.jsii.JsiiObject

(experimental) Exposed secret for log configuration.

Example:

 import software.amazon.awscdk.core.*;
 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();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ExposedSecret

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

ExposedSecret

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

ExposedSecret

@Stability(value=Experimental)
public ExposedSecret(@NotNull
                                                    String optionName,
                                                    @NotNull
                                                    String secretArn)

Parameters:

optionName - This parameter is required.

secretArn - This parameter is required.

Method Detail

fromParametersStore

@Stability(value=Experimental)
 @NotNull
public static ExposedSecret fromParametersStore(@NotNull
                                                                                         String optionName,
                                                                                         @NotNull
                                                                                         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

@Stability(value=Experimental)
 @NotNull
public static ExposedSecret fromSecretsManager(@NotNull
                                                                                        String optionName,
                                                                                        @NotNull
                                                                                        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

@Stability(value=Experimental)
 @NotNull
public String getOptionName()

(experimental) Name of the option.

setOptionName

@Stability(value=Experimental)
public void setOptionName(@NotNull
                                                         String value)

(experimental) Name of the option.

getSecretArn

@Stability(value=Experimental)
 @NotNull
public String getSecretArn()

(experimental) ARN of the secret option.

setSecretArn

@Stability(value=Experimental)
public void setSecretArn(@NotNull
                                                        String value)

(experimental) ARN of the secret option.