Package io.envoyproxy.envoy.extensions.common.aws.v3

Class AssumeRoleWithWebIdentityCredentialProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AssumeRoleWithWebIdentityCredentialProviderOrBuilder, Serializable
public final class AssumeRoleWithWebIdentityCredentialProvider extends com.google.protobuf.GeneratedMessageV3 implements AssumeRoleWithWebIdentityCredentialProviderOrBuilder
 Configuration to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_
 to retrieve AWS credentials.
Protobuf type envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider
See Also:

  • Field Details

    • WEB_IDENTITY_TOKEN_DATA_SOURCE_FIELD_NUMBER

      public static final int WEB_IDENTITY_TOKEN_DATA_SOURCE_FIELD_NUMBER
      See Also:

    • ROLE_ARN_FIELD_NUMBER

      public static final int ROLE_ARN_FIELD_NUMBER
      See Also:

    • ROLE_SESSION_NAME_FIELD_NUMBER

      public static final int ROLE_SESSION_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasWebIdentityTokenDataSource

      public boolean hasWebIdentityTokenDataSource()
       Data source for a web identity token that is provided by the identity provider to assume the role.
 If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
 that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
 automatically watch the directory of a file data source.
 Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      hasWebIdentityTokenDataSource in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      Whether the webIdentityTokenDataSource field is set.

    • getWebIdentityTokenDataSource

      public DataSource getWebIdentityTokenDataSource()
       Data source for a web identity token that is provided by the identity provider to assume the role.
 If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
 that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
 automatically watch the directory of a file data source.
 Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getWebIdentityTokenDataSource in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The webIdentityTokenDataSource.

    • getWebIdentityTokenDataSourceOrBuilder

      public DataSourceOrBuilder getWebIdentityTokenDataSourceOrBuilder()
       Data source for a web identity token that is provided by the identity provider to assume the role.
 If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
 that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
 automatically watch the directory of a file data source.
 Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getWebIdentityTokenDataSourceOrBuilder in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder

    • getRoleArn

      public String getRoleArn()
       The ARN of the role to assume.
      string role_arn = 2 [(.validate.rules) = { ... }
      Specified by:
      getRoleArn in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The roleArn.

    • getRoleArnBytes

      public com.google.protobuf.ByteString getRoleArnBytes()
       The ARN of the role to assume.
      string role_arn = 2 [(.validate.rules) = { ... }
      Specified by:
      getRoleArnBytes in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The bytes for roleArn.

    • getRoleSessionName

      public String getRoleSessionName()
       Optional role session name to use in AssumeRoleWithWebIdentity API call.
      string role_session_name = 3;
      Specified by:
      getRoleSessionName in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The roleSessionName.

    • getRoleSessionNameBytes

      public com.google.protobuf.ByteString getRoleSessionNameBytes()
       Optional role session name to use in AssumeRoleWithWebIdentity API call.
      string role_session_name = 3;
      Specified by:
      getRoleSessionNameBytes in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The bytes for roleSessionName.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AssumeRoleWithWebIdentityCredentialProvider parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AssumeRoleWithWebIdentityCredentialProvider.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AssumeRoleWithWebIdentityCredentialProvider.Builder newBuilder()

    • newBuilder

      public static AssumeRoleWithWebIdentityCredentialProvider.Builder newBuilder(AssumeRoleWithWebIdentityCredentialProvider prototype)

    • toBuilder

      public AssumeRoleWithWebIdentityCredentialProvider.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AssumeRoleWithWebIdentityCredentialProvider.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static AssumeRoleWithWebIdentityCredentialProvider getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AssumeRoleWithWebIdentityCredentialProvider> parser()

    • getParserForType

      public com.google.protobuf.Parser<AssumeRoleWithWebIdentityCredentialProvider> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public AssumeRoleWithWebIdentityCredentialProvider getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder