ProfileProperty (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.profiles.ProfileProperty

```
public final class ProfileProperty
extends Object
```
The properties used by the Java SDK from the credentials and config files.

See Also:

ProfileFile

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCOUNT_ID_ENDPOINT_MODE` The "account id endpoint mode" to be used for clients created using the currently-configured profile.
`static String`	`AWS_ACCESS_KEY_ID` Property name for specifying the Amazon AWS Access Key
`static String`	`AWS_ACCOUNT_ID` Property name for specifying the Amazon AWS Account ID associated with credentials
`static String`	`AWS_SECRET_ACCESS_KEY` Property name for specifying the Amazon AWS Secret Access Key
`static String`	`AWS_SESSION_TOKEN` Property name for specifying the Amazon AWS Session Token
`static String`	`CREDENTIAL_PROCESS` An external process that should be invoked to load credentials.
`static String`	`CREDENTIAL_SOURCE` Property name for specifying the credential source to use when assuming a role
`static String`	`DEFAULTS_MODE` The "defaults mode" to be used for clients created using the currently-configured profile.
`static String`	`DISABLE_REQUEST_COMPRESSION` Whether request compression is disabled for operations marked with the RequestCompression trait.
`static String`	`DISABLE_S3_EXPRESS_AUTH`
`static String`	`DURATION_SECONDS` Property name for specifying how long in seconds to assume the role
`static String`	`EC2_METADATA_SERVICE_ENDPOINT`
`static String`	`EC2_METADATA_SERVICE_ENDPOINT_MODE`
`static String`	`EC2_METADATA_V1_DISABLED`
`static String`	`ENDPOINT_DISCOVERY_ENABLED` Property name for specifying whether or not endpoint discovery is enabled.
`static String`	`ENDPOINT_URL` The endpoint override to use.
`static String`	`EXTERNAL_ID` Property name for specifying the IAM role external id
`static String`	`IBM_API_KEY_ID` Property name for specifying the IBM API Key
`static String`	`IBM_SERVICE_INSTANCE_ID` Property name for specifying the IBM Service Instance ID
`static String`	`METADATA_SERVICE_TIMEOUT`
`static String`	`MFA_SERIAL` Property name for specifying the identification number of the MFA device
`static String`	`REGION` AWS Region to use when creating clients.
`static String`	`REQUEST_CHECKSUM_CALCULATION` The request checksum calculation setting.
`static String`	`REQUEST_MIN_COMPRESSION_SIZE_BYTES` The minimum compression size in bytes, inclusive, for a request to be compressed.
`static String`	`RESPONSE_CHECKSUM_VALIDATION` The response checksum validation setting.
`static String`	`RETRY_MODE` The "retry mode" to be used for clients created using the currently-configured profile.
`static String`	`ROLE_ARN` Property name for specifying the IAM role to assume
`static String`	`ROLE_SESSION_NAME` Property name for specifying the IAM role session name
`static String`	`S3_US_EAST_1_REGIONAL_ENDPOINT` The S3 regional endpoint setting for the `us-east-1` region.
`static String`	`SDK_UA_APP_ID`
`static String`	`SIGV4A_SIGNING_REGION_SET` Property name for specifying the SIGV4A signing region set configuration.
`static String`	`SOURCE_PROFILE` Property name for specifying the profile credentials to use when assuming a role
`static String`	`SSO_ACCOUNT_ID` AWS account ID that temporary AWS credentials will be resolved for.
`static String`	`SSO_REGION` Aws region where the SSO directory for the given 'sso_start_url' is hosted.
`static String`	`SSO_ROLE_NAME` The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.
`static String`	`SSO_START_URL` Start url provided by the SSO service via the console.
`static String`	`USE_DUALSTACK_ENDPOINT`
`static String`	`USE_FIPS_ENDPOINT`
`static String`	`WEB_IDENTITY_TOKEN_FILE`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AWS_ACCESS_KEY_ID
```
public static final String AWS_ACCESS_KEY_ID
```
    Property name for specifying the Amazon AWS Access Key
    
    See Also:
    
    Constant Field Values
  - AWS_SECRET_ACCESS_KEY
```
public static final String AWS_SECRET_ACCESS_KEY
```
    Property name for specifying the Amazon AWS Secret Access Key
    
    See Also:
    
    Constant Field Values
  - IBM_API_KEY_ID
```
public static final String IBM_API_KEY_ID
```
    Property name for specifying the IBM API Key
    
    See Also:
    
    Constant Field Values
  - IBM_SERVICE_INSTANCE_ID
```
public static final String IBM_SERVICE_INSTANCE_ID
```
    Property name for specifying the IBM Service Instance ID
    
    See Also:
    
    Constant Field Values
  - AWS_SESSION_TOKEN
```
public static final String AWS_SESSION_TOKEN
```
    Property name for specifying the Amazon AWS Session Token
    
    See Also:
    
    Constant Field Values
  - AWS_ACCOUNT_ID
```
public static final String AWS_ACCOUNT_ID
```
    Property name for specifying the Amazon AWS Account ID associated with credentials
    
    See Also:
    
    Constant Field Values
  - ROLE_ARN
```
public static final String ROLE_ARN
```
    Property name for specifying the IAM role to assume
    
    See Also:
    
    Constant Field Values
  - ROLE_SESSION_NAME
```
public static final String ROLE_SESSION_NAME
```
    Property name for specifying the IAM role session name
    
    See Also:
    
    Constant Field Values
  - DURATION_SECONDS
```
public static final String DURATION_SECONDS
```
    Property name for specifying how long in seconds to assume the role
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_ID
```
public static final String EXTERNAL_ID
```
    Property name for specifying the IAM role external id
    
    See Also:
    
    Constant Field Values
  - SOURCE_PROFILE
```
public static final String SOURCE_PROFILE
```
    Property name for specifying the profile credentials to use when assuming a role
    
    See Also:
    
    Constant Field Values
  - CREDENTIAL_SOURCE
```
public static final String CREDENTIAL_SOURCE
```
    Property name for specifying the credential source to use when assuming a role
    
    See Also:
    
    Constant Field Values
  - REGION
```
public static final String REGION
```
    AWS Region to use when creating clients.
    
    See Also:
    
    Constant Field Values
  - MFA_SERIAL
```
public static final String MFA_SERIAL
```
    Property name for specifying the identification number of the MFA device
    
    See Also:
    
    Constant Field Values
  - ENDPOINT_DISCOVERY_ENABLED
```
public static final String ENDPOINT_DISCOVERY_ENABLED
```
    Property name for specifying whether or not endpoint discovery is enabled.
    
    See Also:
    
    Constant Field Values
  - CREDENTIAL_PROCESS
```
public static final String CREDENTIAL_PROCESS
```
    An external process that should be invoked to load credentials.
    
    See Also:
    
    Constant Field Values
  - WEB_IDENTITY_TOKEN_FILE
```
public static final String WEB_IDENTITY_TOKEN_FILE
```
    See Also:
    
    Constant Field Values
  - S3_US_EAST_1_REGIONAL_ENDPOINT
```
public static final String S3_US_EAST_1_REGIONAL_ENDPOINT
```
    The S3 regional endpoint setting for the us-east-1 region. Setting the value to regional causes the SDK to use the s3.us-east-1.amazonaws.com endpoint when using the US_EAST_1 region instead of the global s3.amazonaws.com. Using the regional endpoint is disabled by default.
    
    See Also:
    
    Constant Field Values
  - DISABLE_S3_EXPRESS_AUTH
```
public static final String DISABLE_S3_EXPRESS_AUTH
```
    See Also:
    
    Constant Field Values
  - RETRY_MODE
```
public static final String RETRY_MODE
```
    The "retry mode" to be used for clients created using the currently-configured profile. Values supported by all SDKs are "legacy" and "standard". See the RetryMode class JavaDoc for more information.
    
    See Also:
    
    Constant Field Values
  - DEFAULTS_MODE
```
public static final String DEFAULTS_MODE
```
    The "defaults mode" to be used for clients created using the currently-configured profile. Defaults mode determins how SDK default configuration should be resolved. See the DefaultsMode class JavaDoc for more information.
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_ID_ENDPOINT_MODE
```
public static final String ACCOUNT_ID_ENDPOINT_MODE
```
    The "account id endpoint mode" to be used for clients created using the currently-configured profile. This setting can only be used by services that route user requests to account specific endpoints, and determines how endpoints should be resolved depending on the availability of an accountId for a request. See the AccountIdEndpointMode class javadoc for more information.
    
    See Also:
    
    Constant Field Values
  - SSO_REGION
```
public static final String SSO_REGION
```
    Aws region where the SSO directory for the given 'sso_start_url' is hosted. This is independent of the general 'region'.
    
    See Also:
    
    Constant Field Values
  - SSO_ROLE_NAME
```
public static final String SSO_ROLE_NAME
```
    The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.
    
    See Also:
    
    Constant Field Values
  - SSO_ACCOUNT_ID
```
public static final String SSO_ACCOUNT_ID
```
    AWS account ID that temporary AWS credentials will be resolved for.
    
    See Also:
    
    Constant Field Values
  - SSO_START_URL
```
public static final String SSO_START_URL
```
    Start url provided by the SSO service via the console. It's the main URL used for login to the SSO directory. This is also referred to as the "User Portal URL" and can also be used to login to the SSO web interface for AWS console access.
    
    See Also:
    
    Constant Field Values
  - USE_DUALSTACK_ENDPOINT
```
public static final String USE_DUALSTACK_ENDPOINT
```
    See Also:
    
    Constant Field Values
  - USE_FIPS_ENDPOINT
```
public static final String USE_FIPS_ENDPOINT
```
    See Also:
    
    Constant Field Values
  - EC2_METADATA_SERVICE_ENDPOINT_MODE
```
public static final String EC2_METADATA_SERVICE_ENDPOINT_MODE
```
    See Also:
    
    Constant Field Values
  - EC2_METADATA_SERVICE_ENDPOINT
```
public static final String EC2_METADATA_SERVICE_ENDPOINT
```
    See Also:
    
    Constant Field Values
  - EC2_METADATA_V1_DISABLED
```
public static final String EC2_METADATA_V1_DISABLED
```
    See Also:
    
    Constant Field Values
  - METADATA_SERVICE_TIMEOUT
```
public static final String METADATA_SERVICE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DISABLE_REQUEST_COMPRESSION
```
public static final String DISABLE_REQUEST_COMPRESSION
```
    Whether request compression is disabled for operations marked with the RequestCompression trait. The default value is false, i.e., request compression is enabled.
    
    See Also:
    
    Constant Field Values
  - REQUEST_MIN_COMPRESSION_SIZE_BYTES
```
public static final String REQUEST_MIN_COMPRESSION_SIZE_BYTES
```
    The minimum compression size in bytes, inclusive, for a request to be compressed. The default value is 10_240. The value must be non-negative and no greater than 10_485_760.
    
    See Also:
    
    Constant Field Values
  - ENDPOINT_URL
```
public static final String ENDPOINT_URL
```
    The endpoint override to use. This may also be specified under a service-specific parent property to override the endpoint just for that one service.
    
    See Also:
    
    Constant Field Values
  - REQUEST_CHECKSUM_CALCULATION
```
public static final String REQUEST_CHECKSUM_CALCULATION
```
    The request checksum calculation setting. The default value is WHEN_SUPPORTED.
    
    See Also:
    
    Constant Field Values
  - RESPONSE_CHECKSUM_VALIDATION
```
public static final String RESPONSE_CHECKSUM_VALIDATION
```
    The response checksum validation setting. The default value is WHEN_SUPPORTED.
    
    See Also:
    
    Constant Field Values
  - SDK_UA_APP_ID
```
public static final String SDK_UA_APP_ID
```
    See Also:
    
    Constant Field Values
  - SIGV4A_SIGNING_REGION_SET
```
public static final String SIGV4A_SIGNING_REGION_SET
```
    Property name for specifying the SIGV4A signing region set configuration. This optional property is a non-empty, comma-delimited list of non-empty strings, which can be configured via the environment variable AWS_SIGV4A_SIGNING_REGION_SET, or the configuration file property sigv4a_signing_region_set, following standard precedence rules.
    
    See Also:
    
    Constant Field Values

Class ProfileProperty

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

IBM_API_KEY_ID

IBM_SERVICE_INSTANCE_ID

AWS_SESSION_TOKEN

AWS_ACCOUNT_ID

ROLE_ARN

ROLE_SESSION_NAME

DURATION_SECONDS

EXTERNAL_ID

SOURCE_PROFILE

CREDENTIAL_SOURCE

REGION

MFA_SERIAL

ENDPOINT_DISCOVERY_ENABLED

CREDENTIAL_PROCESS

WEB_IDENTITY_TOKEN_FILE

S3_US_EAST_1_REGIONAL_ENDPOINT

DISABLE_S3_EXPRESS_AUTH

RETRY_MODE

DEFAULTS_MODE

ACCOUNT_ID_ENDPOINT_MODE

SSO_REGION

SSO_ROLE_NAME

SSO_ACCOUNT_ID

SSO_START_URL

USE_DUALSTACK_ENDPOINT

USE_FIPS_ENDPOINT

EC2_METADATA_SERVICE_ENDPOINT_MODE

EC2_METADATA_SERVICE_ENDPOINT

EC2_METADATA_V1_DISABLED

METADATA_SERVICE_TIMEOUT

DISABLE_REQUEST_COMPRESSION

REQUEST_MIN_COMPRESSION_SIZE_BYTES

ENDPOINT_URL

REQUEST_CHECKSUM_CALCULATION

RESPONSE_CHECKSUM_VALIDATION

SDK_UA_APP_ID

SIGV4A_SIGNING_REGION_SET