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

Class AssumeRoleCredentialProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AssumeRoleCredentialProviderOrBuilder, Serializable
public final class AssumeRoleCredentialProvider extends com.google.protobuf.GeneratedMessageV3 implements AssumeRoleCredentialProviderOrBuilder
 Configuration to use `AssumeRole <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_ for retrieving new credentials, via role chaining.
 [#next-free-field: 6]
Protobuf type envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider
See Also:

  • Field Details

    • 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:

    • EXTERNAL_ID_FIELD_NUMBER

      public static final int EXTERNAL_ID_FIELD_NUMBER
      See Also:

    • SESSION_DURATION_FIELD_NUMBER

      public static final int SESSION_DURATION_FIELD_NUMBER
      See Also:

    • CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int CREDENTIAL_PROVIDER_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

    • getRoleArn

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

    • getRoleArnBytes

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

    • getRoleSessionName

      public String getRoleSessionName()
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Specified by:
      getRoleSessionName in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The roleSessionName.

    • getRoleSessionNameBytes

      public com.google.protobuf.ByteString getRoleSessionNameBytes()
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Specified by:
      getRoleSessionNameBytes in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The bytes for roleSessionName.

    • getExternalId

      public String getExternalId()
       Optional string value to use as the externalId
      string external_id = 3;
      Specified by:
      getExternalId in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The externalId.

    • getExternalIdBytes

      public com.google.protobuf.ByteString getExternalIdBytes()
       Optional string value to use as the externalId
      string external_id = 3;
      Specified by:
      getExternalIdBytes in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The bytes for externalId.

    • hasSessionDuration

      public boolean hasSessionDuration()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      hasSessionDuration in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      Whether the sessionDuration field is set.

    • getSessionDuration

      public com.google.protobuf.Duration getSessionDuration()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      getSessionDuration in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The sessionDuration.

    • getSessionDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getSessionDurationOrBuilder()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      getSessionDurationOrBuilder in interface AssumeRoleCredentialProviderOrBuilder

    • hasCredentialProvider

      public boolean hasCredentialProvider()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      hasCredentialProvider in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      Whether the credentialProvider field is set.

    • getCredentialProvider

      public AwsCredentialProvider getCredentialProvider()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      getCredentialProvider in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The credentialProvider.

    • getCredentialProviderOrBuilder

      public AwsCredentialProviderOrBuilder getCredentialProviderOrBuilder()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      getCredentialProviderOrBuilder in interface AssumeRoleCredentialProviderOrBuilder

    • 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 AssumeRoleCredentialProvider parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AssumeRoleCredentialProvider.Builder newBuilder()

    • newBuilder

      public static AssumeRoleCredentialProvider.Builder newBuilder(AssumeRoleCredentialProvider prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AssumeRoleCredentialProvider getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AssumeRoleCredentialProvider> 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 AssumeRoleCredentialProvider getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder