Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:47.657Z") @Stability(Experimental) 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();

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • ExposedSecret

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

    • ExposedSecret

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

    • ExposedSecret

      @Stability(Experimental) public ExposedSecret(@NotNull String optionName, @NotNull String secretArn)
      Parameters:
      optionName - This parameter is required.
      secretArn - This parameter is required.

  • Method Details

    • fromParametersStore

      @Stability(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(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(Experimental) @NotNull public String getOptionName()
      (experimental) Name of the option.

    • setOptionName

      @Stability(Experimental) public void setOptionName(@NotNull String value)
      (experimental) Name of the option.

    • getSecretArn

      @Stability(Experimental) @NotNull public String getSecretArn()
      (experimental) ARN of the secret option.

    • setSecretArn

      @Stability(Experimental) public void setSecretArn(@NotNull String value)
      (experimental) ARN of the secret option.