Package org.apache.polaris.core.admin.model

Class AwsStorageConfigInfo

java.lang.Object

org.apache.polaris.core.admin.model.StorageConfigInfo

org.apache.polaris.core.admin.model.AwsStorageConfigInfo

@Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen",
           comments="Generator version: 7.12.0")
public class AwsStorageConfigInfo
extends StorageConfigInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AwsStorageConfigInfo.Builder

Nested classes/interfaces inherited from class org.apache.polaris.core.admin.model.StorageConfigInfo

StorageConfigInfo.StorageTypeEnum

Constructor Summary

Constructors

Constructor	Description
AwsStorageConfigInfo(String roleArn, String externalId, String userArn, String region, String endpoint, String stsEndpoint, Boolean stsUnavailable, String endpointInternal, Boolean pathStyleAccess, StorageConfigInfo.StorageTypeEnum storageType, List<String> allowedLocations)
AwsStorageConfigInfo(StorageConfigInfo.StorageTypeEnum storageType)

Method Summary

Modifier and Type	Method	Description
static AwsStorageConfigInfo.Builder	builder()
static AwsStorageConfigInfo.Builder	builder(StorageConfigInfo.StorageTypeEnum storageType)
boolean	equals(Object o)
String	getEndpoint()	endpoint for S3 requests (optional).
String	getEndpointInternal()	endpoint for S3 requests made by the Polaris Server (optional).
String	getExternalId()	an optional external id used to establish a trust relationship with AWS in the trust policy
Boolean	getPathStyleAccess()	Whether S3 requests to files in this catalog should use 'path-style addressing for buckets'.
String	getRegion()	the aws region where data is stored
String	getRoleArn()	the aws role arn that grants privileges on the S3 buckets
String	getStsEndpoint()	endpoint for STS requests made by the Polaris Server (optional).
Boolean	getStsUnavailable()	if set to `true`, instructs Polaris Servers to avoid using the STS endpoints when obtaining credentials for accessing data and metadata files within the related catalog.
String	getUserArn()	the aws user arn used to assume the aws role
int	hashCode()
String	toString()

Methods inherited from class org.apache.polaris.core.admin.model.StorageConfigInfo

getAllowedLocations, getStorageType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AwsStorageConfigInfo

public AwsStorageConfigInfo(String roleArn,
 String externalId,
 String userArn,
 String region,
 String endpoint,
 String stsEndpoint,
 Boolean stsUnavailable,
 String endpointInternal,
 Boolean pathStyleAccess,
 StorageConfigInfo.StorageTypeEnum storageType,
 List<String> allowedLocations)

AwsStorageConfigInfo

public AwsStorageConfigInfo(StorageConfigInfo.StorageTypeEnum storageType)

Method Details

getRoleArn

public String getRoleArn()

the aws role arn that grants privileges on the S3 buckets

getExternalId

public String getExternalId()

an optional external id used to establish a trust relationship with AWS in the trust policy

getUserArn

public String getUserArn()

the aws user arn used to assume the aws role

getRegion

public String getRegion()

the aws region where data is stored

getEndpoint

public String getEndpoint()

endpoint for S3 requests (optional). Clients always see this value (if it is set). Polaris Servers may be configured to use a different endpoint URI via the `endpointInternal` property.

getStsEndpoint

public String getStsEndpoint()

endpoint for STS requests made by the Polaris Server (optional). If not set, defaults to 'endpointInternal' (which in turn defaults to `endpoint`).

getStsUnavailable

public Boolean getStsUnavailable()

if set to `true`, instructs Polaris Servers to avoid using the STS endpoints when obtaining credentials for accessing data and metadata files within the related catalog. Setting this property to `true` effectively disables vending storage credentials to clients. This setting is intended for configuring catalogs with S3-compatible storage implementations that do not support STS.

getEndpointInternal

public String getEndpointInternal()

endpoint for S3 requests made by the Polaris Server (optional). If set, Polaris Service will use this value instead of `endpoint`. If not set, defaults to `endpoint`. Iceberg REST API clients never see this value.

getPathStyleAccess

public Boolean getPathStyleAccess()

Whether S3 requests to files in this catalog should use 'path-style addressing for buckets'.

builder

public static AwsStorageConfigInfo.Builder builder()

builder

public static AwsStorageConfigInfo.Builder builder(StorageConfigInfo.StorageTypeEnum storageType)

equals

public boolean equals(Object o)

Overrides:

equals in class StorageConfigInfo

hashCode

public int hashCode()

Overrides:

hashCode in class StorageConfigInfo

toString

public String toString()

Overrides:

toString in class StorageConfigInfo