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

Interface AwsCredentialProviderOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AwsCredentialProvider, AwsCredentialProvider.Builder
public interface AwsCredentialProviderOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasAssumeRoleWithWebIdentityProvider

      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;
      Returns:
      Whether the assumeRoleWithWebIdentityProvider field is set.

    • getAssumeRoleWithWebIdentityProvider

      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;
      Returns:
      The assumeRoleWithWebIdentityProvider.

    • getAssumeRoleWithWebIdentityProviderOrBuilder

      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;

    • hasInlineCredential

      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;
      Returns:
      Whether the inlineCredential field is set.

    • getInlineCredential

      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;
      Returns:
      The inlineCredential.

    • getInlineCredentialOrBuilder

      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;

    • hasCredentialsFileProvider

      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;
      Returns:
      Whether the credentialsFileProvider field is set.

    • getCredentialsFileProvider

      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;
      Returns:
      The credentialsFileProvider.

    • getCredentialsFileProviderOrBuilder

      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;

    • getCustomCredentialProviderChain

      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;
      Returns:
      The customCredentialProviderChain.

    • hasIamRolesAnywhereCredentialProvider

      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;
      Returns:
      Whether the iamRolesAnywhereCredentialProvider field is set.

    • getIamRolesAnywhereCredentialProvider

      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;
      Returns:
      The iamRolesAnywhereCredentialProvider.

    • getIamRolesAnywhereCredentialProviderOrBuilder

      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;

    • hasConfigCredentialProvider

      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;
      Returns:
      Whether the configCredentialProvider field is set.

    • getConfigCredentialProvider

      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;
      Returns:
      The configCredentialProvider.

    • getConfigCredentialProviderOrBuilder

      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;

    • hasContainerCredentialProvider

      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;
      Returns:
      Whether the containerCredentialProvider field is set.

    • getContainerCredentialProvider

      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;
      Returns:
      The containerCredentialProvider.

    • getContainerCredentialProviderOrBuilder

      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;

    • hasEnvironmentCredentialProvider

      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;
      Returns:
      Whether the environmentCredentialProvider field is set.

    • getEnvironmentCredentialProvider

      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;
      Returns:
      The environmentCredentialProvider.

    • getEnvironmentCredentialProviderOrBuilder

      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;

    • hasInstanceProfileCredentialProvider

      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;
      Returns:
      Whether the instanceProfileCredentialProvider field is set.

    • getInstanceProfileCredentialProvider

      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;
      Returns:
      The instanceProfileCredentialProvider.

    • getInstanceProfileCredentialProviderOrBuilder

      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;

    • hasAssumeRoleCredentialProvider

      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;
      Returns:
      Whether the assumeRoleCredentialProvider field is set.

    • getAssumeRoleCredentialProvider

      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;
      Returns:
      The assumeRoleCredentialProvider.

    • getAssumeRoleCredentialProviderOrBuilder

      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;