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

Class IAMRolesAnywhereCredentialProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.aws.v3.IAMRolesAnywhereCredentialProvider
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IAMRolesAnywhereCredentialProviderOrBuilder, Serializable
public final class IAMRolesAnywhereCredentialProvider extends com.google.protobuf.GeneratedMessageV3 implements IAMRolesAnywhereCredentialProviderOrBuilder
 Configuration to use `IAM Roles Anywhere <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html>`_
 to retrieve AWS credentials.
 [#next-free-field: 9]
Protobuf type envoy.extensions.common.aws.v3.IAMRolesAnywhereCredentialProvider
See Also:

  • Field Details

    • ROLE_ARN_FIELD_NUMBER

      public static final int ROLE_ARN_FIELD_NUMBER
      See Also:

    • CERTIFICATE_FIELD_NUMBER

      public static final int CERTIFICATE_FIELD_NUMBER
      See Also:

    • CERTIFICATE_CHAIN_FIELD_NUMBER

      public static final int CERTIFICATE_CHAIN_FIELD_NUMBER
      See Also:

    • PRIVATE_KEY_FIELD_NUMBER

      public static final int PRIVATE_KEY_FIELD_NUMBER
      See Also:

    • TRUST_ANCHOR_ARN_FIELD_NUMBER

      public static final int TRUST_ANCHOR_ARN_FIELD_NUMBER
      See Also:

    • PROFILE_ARN_FIELD_NUMBER

      public static final int PROFILE_ARN_FIELD_NUMBER
      See Also:

    • ROLE_SESSION_NAME_FIELD_NUMBER

      public static final int ROLE_SESSION_NAME_FIELD_NUMBER
      See Also:

    • SESSION_DURATION_FIELD_NUMBER

      public static final int SESSION_DURATION_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 via the IAM Roles Anywhere sessions API. See `Configure Roles <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step2>`_ for more details.
      string role_arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getRoleArn in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The roleArn.

    • getRoleArnBytes

      public com.google.protobuf.ByteString getRoleArnBytes()
       The ARN of the role to assume via the IAM Roles Anywhere sessions API. See `Configure Roles <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step2>`_ for more details.
      string role_arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getRoleArnBytes in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The bytes for roleArn.

    • hasCertificate

      public boolean hasCertificate()
       The certificate used for authenticating to the IAM Roles Anywhere service.
 This certificate must match one configured in the IAM Roles Anywhere profile. See `Configure Roles <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step2>`_ for more details.
      .envoy.config.core.v3.DataSource certificate = 2 [(.validate.rules) = { ... }
      Specified by:
      hasCertificate in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      Whether the certificate field is set.

    • getCertificate

      public DataSource getCertificate()
       The certificate used for authenticating to the IAM Roles Anywhere service.
 This certificate must match one configured in the IAM Roles Anywhere profile. See `Configure Roles <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step2>`_ for more details.
      .envoy.config.core.v3.DataSource certificate = 2 [(.validate.rules) = { ... }
      Specified by:
      getCertificate in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The certificate.

    • getCertificateOrBuilder

      public DataSourceOrBuilder getCertificateOrBuilder()
       The certificate used for authenticating to the IAM Roles Anywhere service.
 This certificate must match one configured in the IAM Roles Anywhere profile. See `Configure Roles <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step2>`_ for more details.
      .envoy.config.core.v3.DataSource certificate = 2 [(.validate.rules) = { ... }
      Specified by:
      getCertificateOrBuilder in interface IAMRolesAnywhereCredentialProviderOrBuilder

    • hasCertificateChain

      public boolean hasCertificateChain()
       The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
 A certificate chain can contain a maximum of 5 elements, see `The IAM Roles Anywhere authentication process <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication.html>`_ for more details.
      .envoy.config.core.v3.DataSource certificate_chain = 3;
      Specified by:
      hasCertificateChain in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      Whether the certificateChain field is set.

    • getCertificateChain

      public DataSource getCertificateChain()
       The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
 A certificate chain can contain a maximum of 5 elements, see `The IAM Roles Anywhere authentication process <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication.html>`_ for more details.
      .envoy.config.core.v3.DataSource certificate_chain = 3;
      Specified by:
      getCertificateChain in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The certificateChain.

    • getCertificateChainOrBuilder

      public DataSourceOrBuilder getCertificateChainOrBuilder()
       The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
 A certificate chain can contain a maximum of 5 elements, see `The IAM Roles Anywhere authentication process <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication.html>`_ for more details.
      .envoy.config.core.v3.DataSource certificate_chain = 3;
      Specified by:
      getCertificateChainOrBuilder in interface IAMRolesAnywhereCredentialProviderOrBuilder

    • hasPrivateKey

      public boolean hasPrivateKey()
       The TLS private key matching the certificate provided.
      .envoy.config.core.v3.DataSource private_key = 4 [(.validate.rules) = { ... }
      Specified by:
      hasPrivateKey in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      Whether the privateKey field is set.

    • getPrivateKey

      public DataSource getPrivateKey()
       The TLS private key matching the certificate provided.
      .envoy.config.core.v3.DataSource private_key = 4 [(.validate.rules) = { ... }
      Specified by:
      getPrivateKey in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The privateKey.

    • getPrivateKeyOrBuilder

      public DataSourceOrBuilder getPrivateKeyOrBuilder()
       The TLS private key matching the certificate provided.
      .envoy.config.core.v3.DataSource private_key = 4 [(.validate.rules) = { ... }
      Specified by:
      getPrivateKeyOrBuilder in interface IAMRolesAnywhereCredentialProviderOrBuilder

    • getTrustAnchorArn

      public String getTrustAnchorArn()
       The arn of the IAM Roles Anywhere trust anchor configured in your AWS account. A trust anchor in IAM Roles anywhere establishes
 trust between your certificate authority (CA) and AWS. See `Establish trust <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step1>`_ for more details.
      string trust_anchor_arn = 5 [(.validate.rules) = { ... }
      Specified by:
      getTrustAnchorArn in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The trustAnchorArn.

    • getTrustAnchorArnBytes

      public com.google.protobuf.ByteString getTrustAnchorArnBytes()
       The arn of the IAM Roles Anywhere trust anchor configured in your AWS account. A trust anchor in IAM Roles anywhere establishes
 trust between your certificate authority (CA) and AWS. See `Establish trust <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/getting-started.html#getting-started-step1>`_ for more details.
      string trust_anchor_arn = 5 [(.validate.rules) = { ... }
      Specified by:
      getTrustAnchorArnBytes in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The bytes for trustAnchorArn.

    • getProfileArn

      public String getProfileArn()
       The IAM Roles Anywhere profile ARN configured in your AWS account.
      string profile_arn = 6 [(.validate.rules) = { ... }
      Specified by:
      getProfileArn in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The profileArn.

    • getProfileArnBytes

      public com.google.protobuf.ByteString getProfileArnBytes()
       The IAM Roles Anywhere profile ARN configured in your AWS account.
      string profile_arn = 6 [(.validate.rules) = { ... }
      Specified by:
      getProfileArnBytes in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The bytes for profileArn.

    • getRoleSessionName

      public String getRoleSessionName()
       An optional role session name, used when identifying the role in subsequent AWS API calls.
      string role_session_name = 7;
      Specified by:
      getRoleSessionName in interface IAMRolesAnywhereCredentialProviderOrBuilder
      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.
      string role_session_name = 7;
      Specified by:
      getRoleSessionNameBytes in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The bytes for roleSessionName.

    • hasSessionDuration

      public boolean hasSessionDuration()
       An optional session duration, used when calculating the maximum time before vended credentials expire. This value cannot exceed the value configured
 in the IAM Roles Anywhere profile and the resultant session duration is calculate by the formula `here <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object>`_.
 If no session duration is provided here, the session duration is sourced from the IAM Roles Anywhere profile.
      .google.protobuf.Duration session_duration = 8 [(.validate.rules) = { ... }
      Specified by:
      hasSessionDuration in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      Whether the sessionDuration field is set.

    • getSessionDuration

      public com.google.protobuf.Duration getSessionDuration()
       An optional session duration, used when calculating the maximum time before vended credentials expire. This value cannot exceed the value configured
 in the IAM Roles Anywhere profile and the resultant session duration is calculate by the formula `here <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object>`_.
 If no session duration is provided here, the session duration is sourced from the IAM Roles Anywhere profile.
      .google.protobuf.Duration session_duration = 8 [(.validate.rules) = { ... }
      Specified by:
      getSessionDuration in interface IAMRolesAnywhereCredentialProviderOrBuilder
      Returns:
      The sessionDuration.

    • getSessionDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getSessionDurationOrBuilder()
       An optional session duration, used when calculating the maximum time before vended credentials expire. This value cannot exceed the value configured
 in the IAM Roles Anywhere profile and the resultant session duration is calculate by the formula `here <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object>`_.
 If no session duration is provided here, the session duration is sourced from the IAM Roles Anywhere profile.
      .google.protobuf.Duration session_duration = 8 [(.validate.rules) = { ... }
      Specified by:
      getSessionDurationOrBuilder in interface IAMRolesAnywhereCredentialProviderOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static IAMRolesAnywhereCredentialProvider.Builder newBuilder()

    • newBuilder

      public static IAMRolesAnywhereCredentialProvider.Builder newBuilder(IAMRolesAnywhereCredentialProvider prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static IAMRolesAnywhereCredentialProvider getDefaultInstance()

    • parser

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

    • getParserForType

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