public class AwsProperties
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLIENT_ASSUME_ROLE_ARN
Used by
AssumeRoleAwsClientFactory . |
static java.lang.String |
CLIENT_ASSUME_ROLE_EXTERNAL_ID
Used by
AssumeRoleAwsClientFactory . |
static java.lang.String |
CLIENT_ASSUME_ROLE_REGION
Used by
AssumeRoleAwsClientFactory . |
static java.lang.String |
CLIENT_ASSUME_ROLE_SESSION_NAME
Used by
AssumeRoleAwsClientFactory . |
static java.lang.String |
CLIENT_ASSUME_ROLE_TAGS_PREFIX
Used by
AssumeRoleAwsClientFactory to pass a list of sessions. |
static java.lang.String |
CLIENT_ASSUME_ROLE_TIMEOUT_SEC
Used by
AssumeRoleAwsClientFactory . |
static int |
CLIENT_ASSUME_ROLE_TIMEOUT_SEC_DEFAULT |
static java.lang.String |
CLIENT_CREDENTIALS_PROVIDER
Configure the AWS credentials provider used to create AWS clients.
|
static java.lang.String |
CLIENT_FACTORY
The implementation class of
AwsClientFactory to customize AWS client configurations. |
static java.lang.String |
CLIENT_REGION
Used by
AwsClientFactories.DefaultAwsClientFactory and also
other client factory classes. |
static java.lang.String |
DYNAMODB_ENDPOINT
Configure an alternative endpoint of the DynamoDB service to access.
|
static java.lang.String |
DYNAMODB_TABLE_NAME
DynamoDB table name for
DynamoDbCatalog |
static java.lang.String |
DYNAMODB_TABLE_NAME_DEFAULT |
static java.lang.String |
GLUE_ACCOUNT_ID
The account ID used in a Glue resource ARN, e.g.
|
static java.lang.String |
GLUE_CATALOG_ENDPOINT
Configure an alternative endpoint of the Glue service for GlueCatalog to access.
|
static java.lang.String |
GLUE_CATALOG_ID
The ID of the Glue Data Catalog where the tables reside.
|
static java.lang.String |
GLUE_CATALOG_SKIP_ARCHIVE
If Glue should skip archiving an old table version when creating a new version in a commit.
|
static boolean |
GLUE_CATALOG_SKIP_ARCHIVE_DEFAULT |
static java.lang.String |
GLUE_CATALOG_SKIP_NAME_VALIDATION
If Glue should skip name validations It is recommended to stick to Glue best practice in
https://docs.aws.amazon.com/athena/latest/ug/glue-best-practices.html to make sure operations
are Hive compatible.
|
static boolean |
GLUE_CATALOG_SKIP_NAME_VALIDATION_DEFAULT |
static java.lang.String |
GLUE_LAKEFORMATION_ENABLED
If set, GlueCatalog will use Lake Formation for access control.
|
static boolean |
GLUE_LAKEFORMATION_ENABLED_DEFAULT |
static java.lang.String |
HTTP_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS
Used to configure the connection acquisition timeout in milliseconds for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME_MS
Used to configure the connection max idle time in milliseconds for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE_MS
Used to configure the connection time to live in milliseconds for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_CONNECTION_TIMEOUT_MS
Used to configure the connection timeout in milliseconds for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED
Used to configure whether to enable the expect continue setting for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_MAX_CONNECTIONS
Used to configure the max connections number for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_SOCKET_TIMEOUT_MS
Used to configure the socket timeout in milliseconds for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_TCP_KEEP_ALIVE_ENABLED
Used to configure whether to enable the tcp keep alive setting for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED
Used to configure whether to use idle connection reaper for
ApacheHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_TYPE
The type of
SdkHttpClient implementation used by AwsClientFactory If set, all AWS clients will use this specified HTTP client. |
static java.lang.String |
HTTP_CLIENT_TYPE_APACHE
If this is set under
HTTP_CLIENT_TYPE , ApacheHttpClient will be used as the HTTP Client in AwsClientFactory |
static java.lang.String |
HTTP_CLIENT_TYPE_DEFAULT |
static java.lang.String |
HTTP_CLIENT_TYPE_URLCONNECTION
If this is set under
HTTP_CLIENT_TYPE , UrlConnectionHttpClient will be used as the HTTP
Client in AwsClientFactory |
static java.lang.String |
HTTP_CLIENT_URLCONNECTION_CONNECTION_TIMEOUT_MS
Used to configure the connection timeout in milliseconds for
UrlConnectionHttpClient.Builder . |
static java.lang.String |
HTTP_CLIENT_URLCONNECTION_SOCKET_TIMEOUT_MS
Used to configure the socket timeout in milliseconds for
UrlConnectionHttpClient.Builder . |
static java.lang.String |
LAKE_FORMATION_DB_NAME
Used by
LakeFormationAwsClientFactory . |
static java.lang.String |
LAKE_FORMATION_TABLE_NAME
Used by
LakeFormationAwsClientFactory . |
static java.lang.String |
REST_ACCESS_KEY_ID
Configure the static access key ID used for SigV4 signing.
|
static java.lang.String |
REST_SECRET_ACCESS_KEY
Configure the static secret access key used for SigV4 signing.
|
static java.lang.String |
REST_SESSION_TOKEN
Configure the static session token used for SigV4.
|
static java.lang.String |
REST_SIGNER_REGION
Region to be used by the SigV4 protocol for signing requests.
|
static java.lang.String |
REST_SIGNING_NAME
The service name to be used by the SigV4 protocol for signing requests.
|
static java.lang.String |
REST_SIGNING_NAME_DEFAULT
The default service name (API Gateway and lambda) used during SigV4 signing.
|
static java.lang.String |
S3_ACCELERATION_ENABLED
Determines if S3 client will use the Acceleration Mode, default to false.
|
static boolean |
S3_ACCELERATION_ENABLED_DEFAULT |
static java.lang.String |
S3_ACCESS_POINTS_PREFIX
Used by
S3FileIO , prefix used for bucket access point configuration. |
static java.lang.String |
S3_CHECKSUM_ENABLED
Enables eTag checks for S3 PUT and MULTIPART upload requests.
|
static boolean |
S3_CHECKSUM_ENABLED_DEFAULT |
static java.lang.String |
S3_DELETE_ENABLED
Determines if
S3FileIO deletes the object when io.delete() is called, default to true. |
static boolean |
S3_DELETE_ENABLED_DEFAULT |
static java.lang.String |
S3_DELETE_TAGS_PREFIX
Used by
S3FileIO to tag objects when deleting. |
static java.lang.String |
S3_DUALSTACK_ENABLED
Determines if S3 client will use the Dualstack Mode, default to false.
|
static boolean |
S3_DUALSTACK_ENABLED_DEFAULT |
static java.lang.String |
S3_PRELOAD_CLIENT_ENABLED
This flag controls whether the S3 client will be initialized during the S3FileIO
initialization, instead of default lazy initialization upon use.
|
static boolean |
S3_PRELOAD_CLIENT_ENABLED_DEFAULT |
static java.lang.String |
S3_REMOTE_SIGNING_ENABLED |
static boolean |
S3_REMOTE_SIGNING_ENABLED_DEFAULT |
static java.lang.String |
S3_TAG_ICEBERG_NAMESPACE
Tag name that will be used by
S3_WRITE_TAGS_PREFIX when S3_WRITE_NAMESPACE_TAG_ENABLED is enabled |
static java.lang.String |
S3_TAG_ICEBERG_TABLE
Tag name that will be used by
S3_WRITE_TAGS_PREFIX when S3_WRITE_TABLE_TAG_ENABLED is enabled |
static java.lang.String |
S3_USE_ARN_REGION_ENABLED
Enable to make S3FileIO, to make cross-region call to the region specified in the ARN of an
access point.
|
static boolean |
S3_USE_ARN_REGION_ENABLED_DEFAULT |
static java.lang.String |
S3_WRITE_NAMESPACE_TAG_ENABLED
Used by
GlueCatalog to tag objects when writing. |
static boolean |
S3_WRITE_NAMESPACE_TAG_ENABLED_DEFAULT |
static java.lang.String |
S3_WRITE_TABLE_TAG_ENABLED
Used by
GlueCatalog to tag objects when writing. |
static boolean |
S3_WRITE_TABLE_TAG_ENABLED_DEFAULT |
static java.lang.String |
S3_WRITE_TAGS_PREFIX
Used by
S3FileIO to tag objects when writing. |
static java.lang.String |
S3FILEIO_ACCESS_KEY_ID
Configure the static access key ID used to access S3FileIO.
|
static java.lang.String |
S3FILEIO_ACL
Used to configure canned access control list (ACL) for S3 client to use during write.
|
static java.lang.String |
S3FILEIO_DELETE_BATCH_SIZE
Configure the batch size used when deleting multiple files from a given S3 bucket
|
static int |
S3FILEIO_DELETE_BATCH_SIZE_DEFAULT
Default batch size used when deleting files.
|
static int |
S3FILEIO_DELETE_BATCH_SIZE_MAX
Max possible batch size for deletion.
|
static java.lang.String |
S3FILEIO_DELETE_THREADS
Number of threads to use for adding delete tags to S3 objects, default to
Runtime.availableProcessors() |
static java.lang.String |
S3FILEIO_ENDPOINT
Configure an alternative endpoint of the S3 service for S3FileIO to access.
|
static java.lang.String |
S3FILEIO_MULTIPART_SIZE
The size of a single part for multipart upload requests in bytes (default: 32MB).
|
static int |
S3FILEIO_MULTIPART_SIZE_DEFAULT |
static int |
S3FILEIO_MULTIPART_SIZE_MIN |
static java.lang.String |
S3FILEIO_MULTIPART_THRESHOLD_FACTOR
The threshold expressed as a factor times the multipart size at which to switch from uploading
using a single put object request to uploading using multipart upload (default: 1.5).
|
static double |
S3FILEIO_MULTIPART_THRESHOLD_FACTOR_DEFAULT |
static java.lang.String |
S3FILEIO_MULTIPART_UPLOAD_THREADS
Number of threads to use for uploading parts to S3 (shared pool across all output streams),
default to
Runtime.availableProcessors() |
static java.lang.String |
S3FILEIO_PATH_STYLE_ACCESS
If set
true , requests to S3FileIO will use Path-Style, otherwise, Virtual Hosted-Style
will be used. |
static boolean |
S3FILEIO_PATH_STYLE_ACCESS_DEFAULT |
static java.lang.String |
S3FILEIO_SECRET_ACCESS_KEY
Configure the static secret access key used to access S3FileIO.
|
static java.lang.String |
S3FILEIO_SESSION_TOKEN
Configure the static session token used to access S3FileIO.
|
static java.lang.String |
S3FILEIO_SSE_KEY
If S3 encryption type is SSE-KMS, input is a KMS Key ID or ARN.
|
static java.lang.String |
S3FILEIO_SSE_MD5
If S3 encryption type is SSE-C, input is the base-64 MD5 digest of the secret key.
|
static java.lang.String |
S3FILEIO_SSE_TYPE
Type of S3 Server side encryption used, default to
S3FILEIO_SSE_TYPE_NONE . |
static java.lang.String |
S3FILEIO_SSE_TYPE_CUSTOM
S3 SSE-C encryption.
|
static java.lang.String |
S3FILEIO_SSE_TYPE_KMS
S3 SSE-KMS encryption.
|
static java.lang.String |
S3FILEIO_SSE_TYPE_NONE
No server side encryption.
|
static java.lang.String |
S3FILEIO_SSE_TYPE_S3
S3 SSE-S3 encryption.
|
static java.lang.String |
S3FILEIO_STAGING_DIRECTORY
Location to put staging files for upload to S3, default to temp directory set in
java.io.tmpdir.
|
Constructor and Description |
---|
AwsProperties() |
AwsProperties(java.util.Map<java.lang.String,java.lang.String> properties) |
Modifier and Type | Method and Description |
---|---|
<T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> |
applyClientCredentialConfigurations(T builder)
Configure the credential provider for AWS clients.
|
<T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> |
applyClientRegionConfiguration(T builder)
Configure a client AWS region.
|
<T extends software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder> |
applyDynamoDbEndpointConfigurations(T builder)
Override the endpoint for a dynamoDb client.
|
<T extends software.amazon.awssdk.services.glue.GlueClientBuilder> |
applyGlueEndpointConfigurations(T builder)
Override the endpoint for a glue client.
|
<T extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder> |
applyHttpClientConfigurations(T builder)
Configure the httpClient for a client according to the HttpClientType.
|
<T extends software.amazon.awssdk.services.s3.S3ClientBuilder> |
applyS3CredentialConfigurations(T builder)
Configure the credentials for an S3 client.
|
<T extends software.amazon.awssdk.services.s3.S3ClientBuilder> |
applyS3EndpointConfigurations(T builder)
Override the endpoint for an S3 client.
|
<T extends software.amazon.awssdk.services.s3.S3ClientBuilder> |
applyS3ServiceConfigurations(T builder)
Configure services settings for an S3 client.
|
<T extends software.amazon.awssdk.services.s3.S3ClientBuilder> |
applyS3SignerConfiguration(T builder)
Configure a signer for an S3 client.
|
java.lang.String |
clientAssumeRoleArn() |
java.lang.String |
clientAssumeRoleExternalId() |
java.lang.String |
clientAssumeRoleRegion() |
java.lang.String |
clientAssumeRoleSessionName() |
int |
clientAssumeRoleTimeoutSec() |
java.lang.String |
clientRegion() |
java.lang.String |
dynamoDbTableName() |
java.lang.String |
glueCatalogId() |
boolean |
glueCatalogSkipArchive() |
boolean |
glueCatalogSkipNameValidation() |
boolean |
glueLakeFormationEnabled() |
java.util.Map<java.lang.String,java.lang.String> |
httpClientProperties() |
boolean |
isS3ChecksumEnabled() |
boolean |
isS3DeleteEnabled() |
software.amazon.awssdk.auth.credentials.AwsCredentialsProvider |
restCredentialsProvider() |
java.lang.String |
restSigningName() |
software.amazon.awssdk.regions.Region |
restSigningRegion() |
java.util.Map<java.lang.String,java.lang.String> |
s3BucketToAccessPointMapping() |
java.util.Set<software.amazon.awssdk.services.s3.model.Tag> |
s3DeleteTags() |
software.amazon.awssdk.services.s3.model.ObjectCannedACL |
s3FileIoAcl() |
int |
s3FileIoDeleteBatchSize() |
int |
s3FileIoDeleteThreads() |
int |
s3FileIoMultiPartSize() |
double |
s3FileIOMultipartThresholdFactor() |
int |
s3FileIoMultipartUploadThreads() |
java.lang.String |
s3FileIoSseKey() |
java.lang.String |
s3FileIoSseMd5() |
java.lang.String |
s3FileIoSseType() |
java.lang.String |
s3fileIoStagingDirectory() |
boolean |
s3PreloadClientEnabled() |
boolean |
s3WriteNamespaceTagEnabled() |
boolean |
s3WriteTableTagEnabled() |
java.util.Set<software.amazon.awssdk.services.s3.model.Tag> |
s3WriteTags() |
void |
setClientRegion(java.lang.String clientRegion) |
void |
setDynamoDbTableName(java.lang.String name) |
void |
setGlueCatalogId(java.lang.String id) |
void |
setGlueCatalogSkipArchive(boolean skipArchive) |
void |
setGlueCatalogSkipNameValidation(boolean glueCatalogSkipNameValidation) |
void |
setGlueLakeFormationEnabled(boolean glueLakeFormationEnabled) |
void |
setS3ChecksumEnabled(boolean eTagCheckEnabled) |
void |
setS3DeleteEnabled(boolean s3DeleteEnabled) |
void |
setS3FileIoAcl(software.amazon.awssdk.services.s3.model.ObjectCannedACL acl) |
void |
setS3FileIoDeleteBatchSize(int deleteBatchSize) |
void |
setS3FileIoDeleteThreads(int threads) |
void |
setS3FileIoMultiPartSize(int size) |
void |
setS3FileIoMultipartThresholdFactor(double factor) |
void |
setS3FileIoMultipartUploadThreads(int threads) |
void |
setS3FileIoSseKey(java.lang.String sseKey) |
void |
setS3FileIoSseMd5(java.lang.String sseMd5) |
void |
setS3FileIoSseType(java.lang.String sseType) |
void |
setS3fileIoStagingDirectory(java.lang.String directory) |
void |
setS3PreloadClientEnabled(boolean s3PreloadClientEnabled) |
void |
setS3WriteNamespaceTagEnabled(boolean s3WriteNamespaceTagEnabled) |
void |
setS3WriteTableTagEnabled(boolean s3WriteTableNameTagEnabled) |
java.util.Set<software.amazon.awssdk.services.sts.model.Tag> |
stsClientAssumeRoleTags() |
public static final java.lang.String S3FILEIO_SSE_TYPE
S3FILEIO_SSE_TYPE_NONE
.
For more details: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
public static final java.lang.String S3FILEIO_SSE_TYPE_NONE
public static final java.lang.String S3FILEIO_SSE_TYPE_KMS
For more details: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
public static final java.lang.String S3FILEIO_SSE_TYPE_S3
For more details: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
public static final java.lang.String S3FILEIO_SSE_TYPE_CUSTOM
For more details: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
public static final java.lang.String S3FILEIO_SSE_KEY
public static final java.lang.String S3FILEIO_SSE_MD5
public static final java.lang.String GLUE_CATALOG_ID
For more details, see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html
public static final java.lang.String GLUE_ACCOUNT_ID
public static final java.lang.String GLUE_CATALOG_SKIP_ARCHIVE
public static final boolean GLUE_CATALOG_SKIP_ARCHIVE_DEFAULT
public static final java.lang.String GLUE_CATALOG_SKIP_NAME_VALIDATION
public static final boolean GLUE_CATALOG_SKIP_NAME_VALIDATION_DEFAULT
public static final java.lang.String GLUE_LAKEFORMATION_ENABLED
AwsClientFactory
implementation must be LakeFormationAwsClientFactory
or any class that extends it.public static final boolean GLUE_LAKEFORMATION_ENABLED_DEFAULT
public static final java.lang.String GLUE_CATALOG_ENDPOINT
This could be used to use GlueCatalog with any glue-compatible metastore service that has a different endpoint
public static final java.lang.String S3FILEIO_MULTIPART_UPLOAD_THREADS
Runtime.availableProcessors()
public static final java.lang.String S3FILEIO_MULTIPART_SIZE
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html
public static final int S3FILEIO_MULTIPART_SIZE_DEFAULT
public static final int S3FILEIO_MULTIPART_SIZE_MIN
public static final java.lang.String S3FILEIO_MULTIPART_THRESHOLD_FACTOR
public static final double S3FILEIO_MULTIPART_THRESHOLD_FACTOR_DEFAULT
public static final java.lang.String S3FILEIO_STAGING_DIRECTORY
public static final java.lang.String S3FILEIO_ACL
The input must be one of ObjectCannedACL
,
such as 'public-read-write' For more details:
https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
public static final java.lang.String S3FILEIO_ENDPOINT
This could be used to use S3FileIO with any s3-compatible object storage service that has a different endpoint, or access a private S3 endpoint in a virtual private cloud.
public static final java.lang.String S3FILEIO_PATH_STYLE_ACCESS
true
, requests to S3FileIO will use Path-Style, otherwise, Virtual Hosted-Style
will be used.
For more details: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html
public static final boolean S3FILEIO_PATH_STYLE_ACCESS_DEFAULT
public static final java.lang.String S3FILEIO_ACCESS_KEY_ID
When set, the default client factory will use the basic or session credentials provided
instead of reading the default credential chain to create S3 access credentials. If S3FILEIO_SESSION_TOKEN
is set, session credential is used, otherwise basic credential is
used.
public static final java.lang.String S3FILEIO_SECRET_ACCESS_KEY
When set, the default client factory will use the basic or session credentials provided
instead of reading the default credential chain to create S3 access credentials. If S3FILEIO_SESSION_TOKEN
is set, session credential is used, otherwise basic credential is
used.
public static final java.lang.String S3FILEIO_SESSION_TOKEN
When set, the default client factory will use the session credentials provided instead of reading the default credential chain to create S3 access credentials.
public static final java.lang.String S3_USE_ARN_REGION_ENABLED
By default, attempting to use an access point in a different region will throw an exception. When enabled, this property allows using access points in other regions.
For more details see: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Configuration.html#useArnRegionEnabled--
public static final boolean S3_USE_ARN_REGION_ENABLED_DEFAULT
public static final java.lang.String S3_CHECKSUM_ENABLED
public static final boolean S3_CHECKSUM_ENABLED_DEFAULT
public static final java.lang.String S3_REMOTE_SIGNING_ENABLED
public static final boolean S3_REMOTE_SIGNING_ENABLED_DEFAULT
public static final java.lang.String S3FILEIO_DELETE_BATCH_SIZE
public static final int S3FILEIO_DELETE_BATCH_SIZE_DEFAULT
Refer to https://github.com/apache/hadoop/commit/56dee667707926f3796c7757be1a133a362f05c9 for more details on why this value was chosen.
public static final int S3FILEIO_DELETE_BATCH_SIZE_MAX
public static final java.lang.String DYNAMODB_ENDPOINT
public static final java.lang.String DYNAMODB_TABLE_NAME
DynamoDbCatalog
public static final java.lang.String DYNAMODB_TABLE_NAME_DEFAULT
public static final java.lang.String CLIENT_FACTORY
AwsClientFactory
to customize AWS client configurations. If
set, all AWS clients will be initialized by the specified factory. If not set, AwsClientFactories.defaultFactory()
is used as default factory.public static final java.lang.String CLIENT_ASSUME_ROLE_ARN
AssumeRoleAwsClientFactory
. If set, all AWS clients will assume a role of the
given ARN, instead of using the default credential chain.public static final java.lang.String CLIENT_ASSUME_ROLE_TAGS_PREFIX
AssumeRoleAwsClientFactory
to pass a list of sessions. Each session tag
consists of a key name and an associated value.public static final java.lang.String CLIENT_ASSUME_ROLE_TIMEOUT_SEC
AssumeRoleAwsClientFactory
. The timeout of the assume role session in seconds,
default to 1 hour. At the end of the timeout, a new set of role session credentials will be
fetched through a STS client.public static final int CLIENT_ASSUME_ROLE_TIMEOUT_SEC_DEFAULT
public static final java.lang.String CLIENT_ASSUME_ROLE_EXTERNAL_ID
AssumeRoleAwsClientFactory
. Optional external ID used to assume an IAM role.
For more details, see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
public static final java.lang.String CLIENT_ASSUME_ROLE_REGION
AssumeRoleAwsClientFactory
. If set, all AWS clients except STS client will use
the given region instead of the default region chain.
The value must be one of Region
, such as 'us-east-1'.
For more details, see https://docs.aws.amazon.com/general/latest/gr/rande.html
public static final java.lang.String CLIENT_ASSUME_ROLE_SESSION_NAME
AssumeRoleAwsClientFactory
. Optional session name used to assume an IAM role.
For more details, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_rolesessionname
public static final java.lang.String CLIENT_CREDENTIALS_PROVIDER
AwsCredentialsProvider
interface is required.
Additionally, the implementation class must also have a create() or create(Map) method implemented, which returns an instance of the class that provides aws credentials provider.
Example: client.credentials-provider=software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider
When set, the default client factory AwsClientFactories.DefaultAwsClientFactory
and also other client
factory classes will use this provider to get AWS credentials provided instead of reading the
default credential chain to get AWS access credentials.
public static final java.lang.String CLIENT_REGION
AwsClientFactories.DefaultAwsClientFactory
and also
other client factory classes. If set, all AWS clients except STS client will use the given
region instead of the default region chain.public static final java.lang.String HTTP_CLIENT_TYPE
SdkHttpClient
implementation used by AwsClientFactory
If set, all AWS clients will use this specified HTTP client. If not set,
HTTP_CLIENT_TYPE_DEFAULT
will be used. For specific types supported, see
HTTP_CLIENT_TYPE_* defined below.public static final java.lang.String HTTP_CLIENT_TYPE_URLCONNECTION
HTTP_CLIENT_TYPE
, UrlConnectionHttpClient
will be used as the HTTP
Client in AwsClientFactory
public static final java.lang.String HTTP_CLIENT_TYPE_APACHE
HTTP_CLIENT_TYPE
, ApacheHttpClient
will be used as the HTTP Client in AwsClientFactory
public static final java.lang.String HTTP_CLIENT_TYPE_DEFAULT
public static final java.lang.String HTTP_CLIENT_URLCONNECTION_CONNECTION_TIMEOUT_MS
UrlConnectionHttpClient.Builder
. This flag only
works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_URLCONNECTION
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_URLCONNECTION_SOCKET_TIMEOUT_MS
UrlConnectionHttpClient.Builder
. This flag only
works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_URLCONNECTION
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_CONNECTION_TIMEOUT_MS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_SOCKET_TIMEOUT_MS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME_MS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE_MS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
In default, this is disabled.
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_MAX_CONNECTIONS
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_TCP_KEEP_ALIVE_ENABLED
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
.
In default, this is disabled.
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String HTTP_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED
ApacheHttpClient.Builder
. This flag only works when HTTP_CLIENT_TYPE
is set to HTTP_CLIENT_TYPE_APACHE
.
In default, this is enabled.
For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
public static final java.lang.String S3_WRITE_TAGS_PREFIX
S3FileIO
to tag objects when writing. To set, we can pass a catalog property.
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html
Example: s3.write.tags.my_key=my_val
public static final java.lang.String S3_WRITE_TABLE_TAG_ENABLED
GlueCatalog
to tag objects when writing. To set, we can pass a catalog
property.
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html
Example: s3.write.table-tag-enabled=true
public static final boolean S3_WRITE_TABLE_TAG_ENABLED_DEFAULT
public static final java.lang.String S3_WRITE_NAMESPACE_TAG_ENABLED
GlueCatalog
to tag objects when writing. To set, we can pass a catalog
property.
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html
Example: s3.write.namespace-tag-enabled=true
public static final boolean S3_WRITE_NAMESPACE_TAG_ENABLED_DEFAULT
public static final java.lang.String S3_TAG_ICEBERG_TABLE
S3_WRITE_TAGS_PREFIX
when S3_WRITE_TABLE_TAG_ENABLED
is enabled
Example: iceberg.table=tableName
public static final java.lang.String S3_TAG_ICEBERG_NAMESPACE
S3_WRITE_TAGS_PREFIX
when S3_WRITE_NAMESPACE_TAG_ENABLED
is enabled
Example: iceberg.namespace=namespaceName
public static final java.lang.String S3_DELETE_TAGS_PREFIX
S3FileIO
to tag objects when deleting. When this config is set, objects are
tagged with the configured key-value pairs before deletion. This is considered a soft-delete,
because users are able to configure tag-based object lifecycle policy at bucket level to
transition objects to different tiers.
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
Example: s3.delete.tags.my_key=my_val
public static final java.lang.String S3FILEIO_DELETE_THREADS
Runtime.availableProcessors()
public static final java.lang.String S3_DELETE_ENABLED
S3FileIO
deletes the object when io.delete() is called, default to true.
Once disabled, users are expected to set tags through S3_DELETE_TAGS_PREFIX
and manage
deleted files through S3 lifecycle policy.public static final boolean S3_DELETE_ENABLED_DEFAULT
public static final java.lang.String S3_ACCELERATION_ENABLED
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/transfer-acceleration.html
public static final boolean S3_ACCELERATION_ENABLED_DEFAULT
public static final java.lang.String S3_DUALSTACK_ENABLED
For more details, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html
public static final boolean S3_DUALSTACK_ENABLED_DEFAULT
public static final java.lang.String S3_ACCESS_POINTS_PREFIX
S3FileIO
, prefix used for bucket access point configuration. To set, we can
pass a catalog property.
For more details, see https://aws.amazon.com/s3/features/access-points/
Example: s3.access-points.my-bucket=access-point
public static final java.lang.String S3_PRELOAD_CLIENT_ENABLED
public static final boolean S3_PRELOAD_CLIENT_ENABLED_DEFAULT
public static final java.lang.String LAKE_FORMATION_TABLE_NAME
LakeFormationAwsClientFactory
. The table name used as part of lake formation
credentials request.public static final java.lang.String LAKE_FORMATION_DB_NAME
LakeFormationAwsClientFactory
. The database name used as part of lake formation
credentials request.public static final java.lang.String REST_SIGNER_REGION
public static final java.lang.String REST_SIGNING_NAME
public static final java.lang.String REST_SIGNING_NAME_DEFAULT
public static final java.lang.String REST_ACCESS_KEY_ID
When set, the default client factory will use the basic or session credentials provided
instead of reading the default credential chain to create S3 access credentials. If REST_SESSION_TOKEN
is set, session credential is used, otherwise basic credential is used.
public static final java.lang.String REST_SECRET_ACCESS_KEY
When set, the default client factory will use the basic or session credentials provided
instead of reading the default credential chain to create S3 access credentials. If REST_SESSION_TOKEN
is set, session credential is used, otherwise basic credential is used.
public static final java.lang.String REST_SESSION_TOKEN
When set, the default client factory will use the session credentials provided instead of reading the default credential chain to create access credentials.
public AwsProperties()
public AwsProperties(java.util.Map<java.lang.String,java.lang.String> properties)
public java.util.Set<software.amazon.awssdk.services.sts.model.Tag> stsClientAssumeRoleTags()
public java.lang.String clientAssumeRoleArn()
public int clientAssumeRoleTimeoutSec()
public java.lang.String clientAssumeRoleExternalId()
public java.lang.String clientAssumeRoleRegion()
public java.lang.String clientAssumeRoleSessionName()
public java.lang.String s3FileIoSseType()
public void setS3FileIoSseType(java.lang.String sseType)
public java.lang.String s3FileIoSseKey()
public int s3FileIoDeleteBatchSize()
public void setS3FileIoDeleteBatchSize(int deleteBatchSize)
public void setS3FileIoSseKey(java.lang.String sseKey)
public java.lang.String s3FileIoSseMd5()
public void setS3FileIoSseMd5(java.lang.String sseMd5)
public java.lang.String glueCatalogId()
public void setGlueCatalogId(java.lang.String id)
public boolean glueCatalogSkipArchive()
public void setGlueCatalogSkipArchive(boolean skipArchive)
public boolean glueCatalogSkipNameValidation()
public void setGlueCatalogSkipNameValidation(boolean glueCatalogSkipNameValidation)
public boolean glueLakeFormationEnabled()
public void setGlueLakeFormationEnabled(boolean glueLakeFormationEnabled)
public int s3FileIoMultipartUploadThreads()
public void setS3FileIoMultipartUploadThreads(int threads)
public int s3FileIoMultiPartSize()
public void setS3FileIoMultiPartSize(int size)
public double s3FileIOMultipartThresholdFactor()
public void setS3FileIoMultipartThresholdFactor(double factor)
public java.lang.String s3fileIoStagingDirectory()
public void setS3fileIoStagingDirectory(java.lang.String directory)
public software.amazon.awssdk.services.s3.model.ObjectCannedACL s3FileIoAcl()
public void setS3FileIoAcl(software.amazon.awssdk.services.s3.model.ObjectCannedACL acl)
public void setS3PreloadClientEnabled(boolean s3PreloadClientEnabled)
public boolean s3PreloadClientEnabled()
public java.lang.String dynamoDbTableName()
public void setDynamoDbTableName(java.lang.String name)
public boolean isS3ChecksumEnabled()
public void setS3ChecksumEnabled(boolean eTagCheckEnabled)
public java.util.Set<software.amazon.awssdk.services.s3.model.Tag> s3WriteTags()
public boolean s3WriteTableTagEnabled()
public void setS3WriteTableTagEnabled(boolean s3WriteTableNameTagEnabled)
public boolean s3WriteNamespaceTagEnabled()
public void setS3WriteNamespaceTagEnabled(boolean s3WriteNamespaceTagEnabled)
public java.util.Set<software.amazon.awssdk.services.s3.model.Tag> s3DeleteTags()
public int s3FileIoDeleteThreads()
public void setS3FileIoDeleteThreads(int threads)
public boolean isS3DeleteEnabled()
public void setS3DeleteEnabled(boolean s3DeleteEnabled)
public java.util.Map<java.lang.String,java.lang.String> s3BucketToAccessPointMapping()
public java.util.Map<java.lang.String,java.lang.String> httpClientProperties()
public java.lang.String clientRegion()
public void setClientRegion(java.lang.String clientRegion)
public <T extends software.amazon.awssdk.services.s3.S3ClientBuilder> void applyS3CredentialConfigurations(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyS3CredentialConfigurations)
public <T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> void applyClientRegionConfiguration(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyClientRegionConfiguration)
public <T extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> void applyClientCredentialConfigurations(T builder)
Sample usage:
DynamoDbClient.builder().applyMutation(awsProperties::applyClientCredentialConfigurations)
public <T extends software.amazon.awssdk.services.s3.S3ClientBuilder> void applyS3ServiceConfigurations(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyS3ServiceConfigurations)
public <T extends software.amazon.awssdk.services.s3.S3ClientBuilder> void applyS3SignerConfiguration(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyS3SignerConfiguration)
public <T extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder> void applyHttpClientConfigurations(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyHttpClientConfigurations)
public <T extends software.amazon.awssdk.services.s3.S3ClientBuilder> void applyS3EndpointConfigurations(T builder)
Sample usage:
S3Client.builder().applyMutation(awsProperties::applyS3EndpointConfigurations)
public <T extends software.amazon.awssdk.services.glue.GlueClientBuilder> void applyGlueEndpointConfigurations(T builder)
Sample usage:
GlueClient.builder().applyMutation(awsProperties::applyS3EndpointConfigurations)
public <T extends software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder> void applyDynamoDbEndpointConfigurations(T builder)
Sample usage:
DynamoDbClient.builder().applyMutation(awsProperties::applyS3EndpointConfigurations)
public software.amazon.awssdk.regions.Region restSigningRegion()
public java.lang.String restSigningName()
public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider restCredentialsProvider()