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

Interface AssumeRoleCredentialProviderOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AwsCredentialProvider
    getCredentialProvider()
    The credential provider for signing the AssumeRole request.
    AwsCredentialProviderOrBuilder
    getCredentialProviderOrBuilder()
    The credential provider for signing the AssumeRole request.
    String
    getExternalId()
    Optional string value to use as the externalId
    com.google.protobuf.ByteString
    getExternalIdBytes()
    Optional string value to use as the externalId
    String
    getRoleArn()
    The ARN of the role to assume.
    com.google.protobuf.ByteString
    getRoleArnBytes()
    The ARN of the role to assume.
    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 duration, in seconds, of the role session.
    com.google.protobuf.DurationOrBuilder
    getSessionDurationOrBuilder()
    An optional duration, in seconds, of the role session.
    boolean
    hasCredentialProvider()
    The credential provider for signing the AssumeRole request.
    boolean
    hasSessionDuration()
    An optional duration, in seconds, of the role session.

    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.
      string role_arn = 1 [(.validate.rules) = { ... }
      Returns:
      The roleArn.

    • getRoleArnBytes

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

    • getRoleSessionName

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

    • getRoleSessionNameBytes

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

    • getExternalId

      String getExternalId()
       Optional string value to use as the externalId
      string external_id = 3;
      Returns:
      The externalId.

    • getExternalIdBytes

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

    • hasSessionDuration

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

    • getSessionDuration

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

    • getSessionDurationOrBuilder

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

    • hasCredentialProvider

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

    • getCredentialProvider

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

    • getCredentialProviderOrBuilder

      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;