Package io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3

Interface AwsIamOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCacheName()
    The name of the cache, used when generating the authentication token.
    com.google.protobuf.ByteString
    getCacheNameBytes()
    The name of the cache, used when generating the authentication token.
    AwsCredentialProvider
    getCredentialProvider()
    An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
    AwsCredentialProviderOrBuilder
    getCredentialProviderOrBuilder()
    An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
    com.google.protobuf.Duration
    getExpirationTime()
    Number of seconds before the IAM authentication token will expire.
    com.google.protobuf.DurationOrBuilder
    getExpirationTimeOrBuilder()
    Number of seconds before the IAM authentication token will expire.
    String
    getRegion()
    The optional AWS region that your cache is located in.
    com.google.protobuf.ByteString
    getRegionBytes()
    The optional AWS region that your cache is located in.
    String
    getServiceName()
    The optional service name to be used in AWS IAM authentication.
    com.google.protobuf.ByteString
    getServiceNameBytes()
    The optional service name to be used in AWS IAM authentication.
    boolean
    hasCredentialProvider()
    An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
    boolean
    hasExpirationTime()
    Number of seconds before the IAM authentication token will 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

    • hasCredentialProvider

      boolean hasCredentialProvider()
       An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 1;
      Returns:
      Whether the credentialProvider field is set.

    • getCredentialProvider

      AwsCredentialProvider getCredentialProvider()
       An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 1;
      Returns:
      The credentialProvider.

    • getCredentialProviderOrBuilder

      AwsCredentialProviderOrBuilder getCredentialProviderOrBuilder()
       An AwsCredentialProvider, allowing the use of a specific credential provider chain or specific provider settings
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 1;

    • getCacheName

      String getCacheName()
       The name of the cache, used when generating the authentication token.
      string cache_name = 2 [(.validate.rules) = { ... }
      Returns:
      The cacheName.

    • getCacheNameBytes

      com.google.protobuf.ByteString getCacheNameBytes()
       The name of the cache, used when generating the authentication token.
      string cache_name = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for cacheName.

    • getServiceName

      String getServiceName()
       The optional service name to be used in AWS IAM authentication. If not provided, the service name will be set to ``elasticache``. For Amazon MemoryDB
 the service name should be set to ``memorydb``.
      string service_name = 3;
      Returns:
      The serviceName.

    • getServiceNameBytes

      com.google.protobuf.ByteString getServiceNameBytes()
       The optional service name to be used in AWS IAM authentication. If not provided, the service name will be set to ``elasticache``. For Amazon MemoryDB
 the service name should be set to ``memorydb``.
      string service_name = 3;
      Returns:
      The bytes for serviceName.

    • getRegion

      String getRegion()
       The optional AWS region that your cache is located in. If not provided, the region will be deduced using the region provider chain
 as described in :ref:`config_http_filters_aws_request_signing_region`.
      string region = 4;
      Returns:
      The region.

    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       The optional AWS region that your cache is located in. If not provided, the region will be deduced using the region provider chain
 as described in :ref:`config_http_filters_aws_request_signing_region`.
      string region = 4;
      Returns:
      The bytes for region.

    • hasExpirationTime

      boolean hasExpirationTime()
       Number of seconds before the IAM authentication token will expire. If not set, defaults to 60s (1 minute). Maximum of 900s (15 minutes)
 Expiration of the current authentication token will automatically trigger generation of a new token.
 As envoy will automatically continue to generate new tokens as required, there is no substantial benefit to using a long expiration value here.
      .google.protobuf.Duration expiration_time = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      com.google.protobuf.Duration getExpirationTime()
       Number of seconds before the IAM authentication token will expire. If not set, defaults to 60s (1 minute). Maximum of 900s (15 minutes)
 Expiration of the current authentication token will automatically trigger generation of a new token.
 As envoy will automatically continue to generate new tokens as required, there is no substantial benefit to using a long expiration value here.
      .google.protobuf.Duration expiration_time = 5 [(.validate.rules) = { ... }
      Returns:
      The expirationTime.

    • getExpirationTimeOrBuilder

      com.google.protobuf.DurationOrBuilder getExpirationTimeOrBuilder()
       Number of seconds before the IAM authentication token will expire. If not set, defaults to 60s (1 minute). Maximum of 900s (15 minutes)
 Expiration of the current authentication token will automatically trigger generation of a new token.
 As envoy will automatically continue to generate new tokens as required, there is no substantial benefit to using a long expiration value here.
      .google.protobuf.Duration expiration_time = 5 [(.validate.rules) = { ... }