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

Interface IAMRolesAnywhereCredentialProviderOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    DataSource
    getCertificate()
    The certificate used for authenticating to the IAM Roles Anywhere service.
    DataSource
    getCertificateChain()
    The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
    DataSourceOrBuilder
    getCertificateChainOrBuilder()
    The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
    DataSourceOrBuilder
    getCertificateOrBuilder()
    The certificate used for authenticating to the IAM Roles Anywhere service.
    DataSource
    getPrivateKey()
    The TLS private key matching the certificate provided.
    DataSourceOrBuilder
    getPrivateKeyOrBuilder()
    The TLS private key matching the certificate provided.
    String
    getProfileArn()
    The IAM Roles Anywhere profile ARN configured in your AWS account.
    com.google.protobuf.ByteString
    getProfileArnBytes()
    The IAM Roles Anywhere profile ARN configured in your AWS account.
    String
    getRoleArn()
    The ARN of the role to assume via the IAM Roles Anywhere sessions API.
    com.google.protobuf.ByteString
    getRoleArnBytes()
    The ARN of the role to assume via the IAM Roles Anywhere sessions API.
    String
    getRoleSessionName()
    An optional role session name, used when identifying the role in subsequent AWS API calls.
    com.google.protobuf.ByteString
    getRoleSessionNameBytes()
    An optional role session name, used when identifying the role in subsequent AWS API calls.
    com.google.protobuf.Duration
    getSessionDuration()
    An optional session duration, used when calculating the maximum time before vended credentials expire.
    com.google.protobuf.DurationOrBuilder
    getSessionDurationOrBuilder()
    An optional session duration, used when calculating the maximum time before vended credentials expire.
    String
    getTrustAnchorArn()
    The arn of the IAM Roles Anywhere trust anchor configured in your AWS account.
    com.google.protobuf.ByteString
    getTrustAnchorArnBytes()
    The arn of the IAM Roles Anywhere trust anchor configured in your AWS account.
    boolean
    hasCertificate()
    The certificate used for authenticating to the IAM Roles Anywhere service.
    boolean
    hasCertificateChain()
    The optional certificate chain, required when you are using a subordinate certificate authority for certificate issuance.
    boolean
    hasPrivateKey()
    The TLS private key matching the certificate provided.
    boolean
    hasSessionDuration()
    An optional session duration, used when calculating the maximum time before vended credentials expire.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getRoleArn

      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) = { ... }
      Returns:
      The roleArn.

    • getRoleArnBytes

      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) = { ... }
      Returns:
      The bytes for roleArn.

    • hasCertificate

      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) = { ... }
      Returns:
      Whether the certificate field is set.

    • getCertificate

      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) = { ... }
      Returns:
      The certificate.

    • getCertificateOrBuilder

      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) = { ... }

    • hasCertificateChain

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

    • getCertificateChain

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

    • getCertificateChainOrBuilder

      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;

    • hasPrivateKey

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

    • getPrivateKey

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

    • getPrivateKeyOrBuilder

      DataSourceOrBuilder getPrivateKeyOrBuilder()
       The TLS private key matching the certificate provided.
      .envoy.config.core.v3.DataSource private_key = 4 [(.validate.rules) = { ... }

    • getTrustAnchorArn

      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) = { ... }
      Returns:
      The trustAnchorArn.

    • getTrustAnchorArnBytes

      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) = { ... }
      Returns:
      The bytes for trustAnchorArn.

    • getProfileArn

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

    • getProfileArnBytes

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

    • getRoleSessionName

      String getRoleSessionName()
       An optional role session name, used when identifying the role in subsequent AWS API calls.
      string role_session_name = 7;
      Returns:
      The roleSessionName.

    • getRoleSessionNameBytes

      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;
      Returns:
      The bytes for roleSessionName.

    • hasSessionDuration

      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) = { ... }
      Returns:
      Whether the sessionDuration field is set.

    • getSessionDuration

      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) = { ... }
      Returns:
      The sessionDuration.

    • getSessionDurationOrBuilder

      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) = { ... }