Package software.amazon.awscdk.services.ecs

Class CredentialSpec

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ecs.CredentialSpec
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
DomainJoinedCredentialSpec, DomainlessCredentialSpec
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:06.544Z") @Stability(Stable) public class CredentialSpec extends software.amazon.jsii.JsiiObject
Base construct for a credential specification (CredSpec).

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.ecs.*;
 CredentialSpec credentialSpec = new CredentialSpec("prefixId", "fileLocation");

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CredentialSpec(String prefixId, String fileLocation)
     
    protected
    CredentialSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CredentialSpec(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static String
    arnForS3Object(IBucket bucket, String key)
    Helper method to generate the ARN for a S3 object.
    protected static String
    arnForSsmParameter(IParameter parameter)
    Helper method to generate the ARN for a SSM parameter.
    CredentialSpecConfig
    bind()
    Called when the container is initialized to allow this object to bind to the stack.
    String
    getFileLocation()
    Location or ARN from where to retrieve the CredSpec file.
    String
    getPrefixId()
    Prefix string based on the type of CredSpec.

    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

    • CredentialSpec

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

    • CredentialSpec

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

    • CredentialSpec

      @Stability(Stable) public CredentialSpec(@NotNull String prefixId, @NotNull String fileLocation)
      Parameters:
      prefixId - This parameter is required.
      fileLocation - Location or ARN from where to retrieve the CredSpec file. This parameter is required.

  • Method Details

    • arnForS3Object

      @Stability(Stable) @NotNull protected static String arnForS3Object(@NotNull IBucket bucket, @NotNull String key)
      Helper method to generate the ARN for a S3 object.

      Used to avoid duplication of logic in derived classes.

      Parameters:
      bucket - This parameter is required.
      key - This parameter is required.

    • arnForSsmParameter

      @Stability(Stable) @NotNull protected static String arnForSsmParameter(@NotNull IParameter parameter)
      Helper method to generate the ARN for a SSM parameter.

      Used to avoid duplication of logic in derived classes.

      Parameters:
      parameter - This parameter is required.

    • bind

      @Stability(Stable) @NotNull public CredentialSpecConfig bind()
      Called when the container is initialized to allow this object to bind to the stack.

    • getFileLocation

      @Stability(Stable) @NotNull public String getFileLocation()
      Location or ARN from where to retrieve the CredSpec file.

    • getPrefixId

      @Stability(Stable) @NotNull public String getPrefixId()
      Prefix string based on the type of CredSpec.