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

Class AwsCredentialProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.aws.v3.AwsCredentialProvider
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AwsCredentialProviderOrBuilder, Serializable
public final class AwsCredentialProvider extends com.google.protobuf.GeneratedMessageV3 implements AwsCredentialProviderOrBuilder
 Configuration for AWS credential provider. This is optional and the credentials are normally
 retrieved from the environment or AWS configuration files by following the default credential
 provider chain. However, this configuration can be used to override the default behavior.
 [#next-free-field: 11]
Protobuf type envoy.extensions.common.aws.v3.AwsCredentialProvider
See Also:

  • Field Details

    • ASSUME_ROLE_WITH_WEB_IDENTITY_PROVIDER_FIELD_NUMBER

      public static final int ASSUME_ROLE_WITH_WEB_IDENTITY_PROVIDER_FIELD_NUMBER
      See Also:

    • INLINE_CREDENTIAL_FIELD_NUMBER

      public static final int INLINE_CREDENTIAL_FIELD_NUMBER
      See Also:

    • CREDENTIALS_FILE_PROVIDER_FIELD_NUMBER

      public static final int CREDENTIALS_FILE_PROVIDER_FIELD_NUMBER
      See Also:

    • CUSTOM_CREDENTIAL_PROVIDER_CHAIN_FIELD_NUMBER

      public static final int CUSTOM_CREDENTIAL_PROVIDER_CHAIN_FIELD_NUMBER
      See Also:

    • IAM_ROLES_ANYWHERE_CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int IAM_ROLES_ANYWHERE_CREDENTIAL_PROVIDER_FIELD_NUMBER
      See Also:

    • CONFIG_CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int CONFIG_CREDENTIAL_PROVIDER_FIELD_NUMBER
      See Also:

    • CONTAINER_CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int CONTAINER_CREDENTIAL_PROVIDER_FIELD_NUMBER
      See Also:

    • ENVIRONMENT_CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int ENVIRONMENT_CREDENTIAL_PROVIDER_FIELD_NUMBER
      See Also:

    • INSTANCE_PROFILE_CREDENTIAL_PROVIDER_FIELD_NUMBER

      public static final int INSTANCE_PROFILE_CREDENTIAL_PROVIDER_FIELD_NUMBER
      See Also:

    • ASSUME_ROLE_CREDENTIAL_PROVIDER_FIELD_NUMBER

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

    • hasAssumeRoleWithWebIdentityProvider

      public boolean hasAssumeRoleWithWebIdentityProvider()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      hasAssumeRoleWithWebIdentityProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the assumeRoleWithWebIdentityProvider field is set.

    • getAssumeRoleWithWebIdentityProvider

      public AssumeRoleWithWebIdentityCredentialProvider getAssumeRoleWithWebIdentityProvider()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      getAssumeRoleWithWebIdentityProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The assumeRoleWithWebIdentityProvider.

    • getAssumeRoleWithWebIdentityProviderOrBuilder

      public AssumeRoleWithWebIdentityCredentialProviderOrBuilder getAssumeRoleWithWebIdentityProviderOrBuilder()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      getAssumeRoleWithWebIdentityProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasInlineCredential

      public boolean hasInlineCredential()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      hasInlineCredential in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the inlineCredential field is set.

    • getInlineCredential

      public InlineCredentialProvider getInlineCredential()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      getInlineCredential in interface AwsCredentialProviderOrBuilder
      Returns:
      The inlineCredential.

    • getInlineCredentialOrBuilder

      public InlineCredentialProviderOrBuilder getInlineCredentialOrBuilder()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      getInlineCredentialOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasCredentialsFileProvider

      public boolean hasCredentialsFileProvider()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      hasCredentialsFileProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the credentialsFileProvider field is set.

    • getCredentialsFileProvider

      public CredentialsFileCredentialProvider getCredentialsFileProvider()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      getCredentialsFileProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The credentialsFileProvider.

    • getCredentialsFileProviderOrBuilder

      public CredentialsFileCredentialProviderOrBuilder getCredentialsFileProviderOrBuilder()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      getCredentialsFileProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • getCustomCredentialProviderChain

      public boolean getCustomCredentialProviderChain()
       Create a custom credential provider chain instead of the default credential provider chain.
 If set to TRUE, the credential provider chain that is created contains only those set in this credential provider message.
 If set to FALSE, the settings provided here will act as modifiers to the default credential provider chain.
 Defaults to FALSE.

 This has no effect if inline_credential is provided.
      bool custom_credential_provider_chain = 4;
      Specified by:
      getCustomCredentialProviderChain in interface AwsCredentialProviderOrBuilder
      Returns:
      The customCredentialProviderChain.

    • hasIamRolesAnywhereCredentialProvider

      public boolean hasIamRolesAnywhereCredentialProvider()
       The option to use `IAM Roles Anywhere <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html>`_.
      .envoy.extensions.common.aws.v3.IAMRolesAnywhereCredentialProvider iam_roles_anywhere_credential_provider = 5;
      Specified by:
      hasIamRolesAnywhereCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the iamRolesAnywhereCredentialProvider field is set.

    • getIamRolesAnywhereCredentialProvider

      public IAMRolesAnywhereCredentialProvider getIamRolesAnywhereCredentialProvider()
       The option to use `IAM Roles Anywhere <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html>`_.
      .envoy.extensions.common.aws.v3.IAMRolesAnywhereCredentialProvider iam_roles_anywhere_credential_provider = 5;
      Specified by:
      getIamRolesAnywhereCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The iamRolesAnywhereCredentialProvider.

    • getIamRolesAnywhereCredentialProviderOrBuilder

      public IAMRolesAnywhereCredentialProviderOrBuilder getIamRolesAnywhereCredentialProviderOrBuilder()
       The option to use `IAM Roles Anywhere <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html>`_.
      .envoy.extensions.common.aws.v3.IAMRolesAnywhereCredentialProvider iam_roles_anywhere_credential_provider = 5;
      Specified by:
      getIamRolesAnywhereCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasConfigCredentialProvider

      public boolean hasConfigCredentialProvider()
       The option to use credentials sourced from standard `AWS configuration files <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_.
      .envoy.extensions.common.aws.v3.ConfigCredentialProvider config_credential_provider = 6;
      Specified by:
      hasConfigCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the configCredentialProvider field is set.

    • getConfigCredentialProvider

      public ConfigCredentialProvider getConfigCredentialProvider()
       The option to use credentials sourced from standard `AWS configuration files <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_.
      .envoy.extensions.common.aws.v3.ConfigCredentialProvider config_credential_provider = 6;
      Specified by:
      getConfigCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The configCredentialProvider.

    • getConfigCredentialProviderOrBuilder

      public ConfigCredentialProviderOrBuilder getConfigCredentialProviderOrBuilder()
       The option to use credentials sourced from standard `AWS configuration files <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_.
      .envoy.extensions.common.aws.v3.ConfigCredentialProvider config_credential_provider = 6;
      Specified by:
      getConfigCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasContainerCredentialProvider

      public boolean hasContainerCredentialProvider()
       The option to use credentials sourced from `container environment variables <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>`_.
      .envoy.extensions.common.aws.v3.ContainerCredentialProvider container_credential_provider = 7;
      Specified by:
      hasContainerCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the containerCredentialProvider field is set.

    • getContainerCredentialProvider

      public ContainerCredentialProvider getContainerCredentialProvider()
       The option to use credentials sourced from `container environment variables <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>`_.
      .envoy.extensions.common.aws.v3.ContainerCredentialProvider container_credential_provider = 7;
      Specified by:
      getContainerCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The containerCredentialProvider.

    • getContainerCredentialProviderOrBuilder

      public ContainerCredentialProviderOrBuilder getContainerCredentialProviderOrBuilder()
       The option to use credentials sourced from `container environment variables <https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html>`_.
      .envoy.extensions.common.aws.v3.ContainerCredentialProvider container_credential_provider = 7;
      Specified by:
      getContainerCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasEnvironmentCredentialProvider

      public boolean hasEnvironmentCredentialProvider()
       The option to use credentials sourced from `environment variables <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html>`_.
      .envoy.extensions.common.aws.v3.EnvironmentCredentialProvider environment_credential_provider = 8;
      Specified by:
      hasEnvironmentCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the environmentCredentialProvider field is set.

    • getEnvironmentCredentialProvider

      public EnvironmentCredentialProvider getEnvironmentCredentialProvider()
       The option to use credentials sourced from `environment variables <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html>`_.
      .envoy.extensions.common.aws.v3.EnvironmentCredentialProvider environment_credential_provider = 8;
      Specified by:
      getEnvironmentCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The environmentCredentialProvider.

    • getEnvironmentCredentialProviderOrBuilder

      public EnvironmentCredentialProviderOrBuilder getEnvironmentCredentialProviderOrBuilder()
       The option to use credentials sourced from `environment variables <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html>`_.
      .envoy.extensions.common.aws.v3.EnvironmentCredentialProvider environment_credential_provider = 8;
      Specified by:
      getEnvironmentCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasInstanceProfileCredentialProvider

      public boolean hasInstanceProfileCredentialProvider()
       The option to use credentials sourced from an EC2 `Instance Profile <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_.
      .envoy.extensions.common.aws.v3.InstanceProfileCredentialProvider instance_profile_credential_provider = 9;
      Specified by:
      hasInstanceProfileCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the instanceProfileCredentialProvider field is set.

    • getInstanceProfileCredentialProvider

      public InstanceProfileCredentialProvider getInstanceProfileCredentialProvider()
       The option to use credentials sourced from an EC2 `Instance Profile <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_.
      .envoy.extensions.common.aws.v3.InstanceProfileCredentialProvider instance_profile_credential_provider = 9;
      Specified by:
      getInstanceProfileCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The instanceProfileCredentialProvider.

    • getInstanceProfileCredentialProviderOrBuilder

      public InstanceProfileCredentialProviderOrBuilder getInstanceProfileCredentialProviderOrBuilder()
       The option to use credentials sourced from an EC2 `Instance Profile <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_.
      .envoy.extensions.common.aws.v3.InstanceProfileCredentialProvider instance_profile_credential_provider = 9;
      Specified by:
      getInstanceProfileCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasAssumeRoleCredentialProvider

      public boolean hasAssumeRoleCredentialProvider()
       The option to use `STS:AssumeRole aka Role Chaining <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider assume_role_credential_provider = 10;
      Specified by:
      hasAssumeRoleCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the assumeRoleCredentialProvider field is set.

    • getAssumeRoleCredentialProvider

      public AssumeRoleCredentialProvider getAssumeRoleCredentialProvider()
       The option to use `STS:AssumeRole aka Role Chaining <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider assume_role_credential_provider = 10;
      Specified by:
      getAssumeRoleCredentialProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The assumeRoleCredentialProvider.

    • getAssumeRoleCredentialProviderOrBuilder

      public AssumeRoleCredentialProviderOrBuilder getAssumeRoleCredentialProviderOrBuilder()
       The option to use `STS:AssumeRole aka Role Chaining <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider assume_role_credential_provider = 10;
      Specified by:
      getAssumeRoleCredentialProviderOrBuilder in interface AwsCredentialProviderOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AwsCredentialProvider.Builder newBuilder()

    • newBuilder

      public static AwsCredentialProvider.Builder newBuilder(AwsCredentialProvider prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AwsCredentialProvider getDefaultInstance()

    • parser

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

    • getParserForType

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