AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
A named group of options that are persisted and used to obtain AWSCredentials.
Namespace: Amazon.Runtime.CredentialManagement
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
public class CredentialProfile
The CredentialProfile type exposes the following members
| Name | Description | |
|---|---|---|
|
CredentialProfile(string, CredentialProfileOptions) |
Construct a new CredentialProfile. |
| Name | Type | Description | |
|---|---|---|---|
|
AccountIdEndpointMode | System.Nullable<Amazon.Runtime.AccountIdEndpointMode> |
The Account ID endpoint mode as preferred, required, or disabled. |
|
AuthSchemePreference | System.Collections.Generic.List<System.String> |
List of preferred authentication schemes in priority order. |
|
CanCreateAWSCredentials | System.Boolean |
True if the properties of the Options object can be converted into AWSCredentials, false otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for more details about which options are available. |
|
ClientAppId | System.String |
Customers can opt-in to provide an app id that is intended to identify their applications in the user agent header string. The value should have a maximum length of 50. |
|
CredentialDescription | System.String |
If CanCreateAWSCredentials is true, returns a short description of the type of credentials that would be created. If CanCreateAWSCredentials is false, return null. |
|
CredentialProfileStore | Amazon.Runtime.CredentialManagement.ICredentialProfileStore |
The Amazon.Runtime.CredentialManagement.ICredentialProfileStore that this Amazon.Runtime.CredentialManagement.CredentialProfile is associated with. Null if this Amazon.Runtime.CredentialManagement.CredentialProfile is not associated with a Amazon.Runtime.CredentialManagement.ICredentialProfileStore. |
|
DefaultConfigurationModeName | System.String |
The desired Amazon.Runtime.DefaultConfiguration.Name that Amazon.Runtime.Internal.IDefaultConfigurationProvider should use. If this is null/empty, then the Amazon.Runtime.DefaultConfigurationMode.Standard Mode will be used. |
|
DisableClockSkewCorrection | System.Nullable<System.Boolean> |
Controls whether the SDK corrects the request signing timestamp to compensate for clock drift between the caller and the service (Clock Skew Correction specification). Set to "true" to disable clock skew correction. Default is enabled / false. |
|
DisableRequestCompression | System.Nullable<System.Boolean> |
Controls whether request payloads are automatically compressed for supported operations. This setting only applies to operations that support compression. The default value is "false". Set to "true" to disable compression. |
|
EC2MetadataServiceEndpoint | System.String |
Endpoint of the EC2 Instance Metadata Service |
|
EC2MetadataServiceEndpointMode | System.Nullable<Amazon.Runtime.EC2MetadataServiceEndpointMode> |
Internet protocol version to be used for communicating with the EC2 Instance Metadata Service |
|
EndpointDiscoveryEnabled | System.Nullable<System.Boolean> |
The endpoint discovery enabled value for this CredentialProfile |
|
EndpointUrl | System.String |
This configures the global endpoint URL for a profile. This cannot be used in a services section and will be ignored if set in the services section. |
|
IgnoreConfiguredEndpointUrls | System.Nullable<System.Boolean> |
If this flag is set to true, the SDK will ignore the configured endpoint urls set in the configuration file. |
|
MaxAttempts | System.Nullable<System.Int32> |
Specified how many HTTP requests an SDK should make for a single SDK operation invocation before giving up. |
|
Name | System.String |
The name of the CredentialProfile |
|
Options | Amazon.Runtime.CredentialManagement.CredentialProfileOptions |
The options to be used to create AWSCredentials. |
|
Region | Amazon.RegionEndpoint |
The region to be used with this CredentialProfile |
|
RequestChecksumCalculation | System.Nullable<Amazon.Runtime.RequestChecksumCalculation> |
Determines the behavior for calculating checksums for request payloads. |
|
RequestMinCompressionSizeBytes | System.Nullable<System.Int64> |
Minimum size in bytes that a request body should be to trigger compression. |
|
ResponseChecksumValidation | System.Nullable<Amazon.Runtime.ResponseChecksumValidation> |
Determines the behavior for validating checksums on response payloads. |
|
RetryMode | System.Nullable<Amazon.Runtime.RequestRetryMode> |
The request retry mode as standard or adaptive |
|
S3DisableExpressSessionAuth | System.Nullable<System.Boolean> |
Disables this client's usage of Session Auth for S3Express buckets and reverts to using conventional SigV4. |
|
S3DisableMultiRegionAccessPoints | System.Nullable<System.Boolean> |
If true, the use of multi-region access points is disabled. |
|
S3RegionalEndpoint | System.Nullable<Amazon.Runtime.S3UsEast1RegionalEndpointValue> |
The S3 Regional Endpoint Value as either legacy or regional |
|
S3UseArnRegion | System.Nullable<System.Boolean> |
If true the region identified in the S3 access point arn will be used when making requests. |
|
Services | System.String |
The name of the section which contains the custom endpoints for a service or services. For example: [profile foo] services = bar [services bar] s3 = endpoint_url = https://custom-endpoint-s3:80 ec2 = endpoint_url = https://custome-endpoint_ec2:80 This will tell the SDK to look for custom endpoints in "bar" for the profile "foo. A single Services section can contain configurations for multiple services. |
|
SigV4aSigningRegionSet | System.Collections.Generic.List<System.String> |
List of AWS regions for SigV4a multi-region signing. |
|
UseDualstackEndpoint | System.Nullable<System.Boolean> |
Configures the endpoint calculation to go to a dual stack (ipv6 enabled) endpoint for the configured region. |
|
UseFIPSEndpoint | System.Nullable<System.Boolean> |
Configures the endpoint calculation to go to a FIPS (https://aws.amazon.com/compliance/fips/) endpoint for the configured region. |
| Name | Description | |
|---|---|---|
|
GetAWSCredentials(ICredentialProfileSource) |
Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for a list of AWSCredentials returned by this method. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer