AWS SDK Version 3 for .NET
API Reference

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.

Inheritance Hierarchy


Namespace: Amazon.Runtime.CredentialManagement
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z


public class CredentialProfile

The CredentialProfile type exposes the following members


Public Method CredentialProfile(string, CredentialProfileOptions)

Construct a new CredentialProfile.


Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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.Legacy Mode will be used.

Public Property 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.

Public Property EC2MetadataServiceEndpoint System.String

Endpoint of the EC2 Instance Metadata Service

Public Property EC2MetadataServiceEndpointMode System.Nullable<Amazon.Runtime.EC2MetadataServiceEndpointMode>

Internet protocol version to be used for communicating with the EC2 Instance Metadata Service

Public Property EC2MetadataV1Disabled System.Nullable<System.Boolean>

If set to true the SDK logic for falling back to V1 will be disabled. When using the SDK on an EC2 instance that has configured instance metadata service to use V1 only, a InvalidOperationException exception will be thrown when attempting to access the metadata in EC2 instance metadata.This includes AWS credentials and region information.

Public Property EndpointDiscoveryEnabled System.Nullable<System.Boolean>

The endpoint discovery enabled value for this CredentialProfile

Public Property 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.

Public Property 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.

Public Property MaxAttempts System.Nullable<System.Int32>

Specified how many HTTP requests an SDK should make for a single SDK operation invocation before giving up.

Public Property Name System.String

The name of the CredentialProfile

Public Property Options Amazon.Runtime.CredentialManagement.CredentialProfileOptions

The options to be used to create AWSCredentials.

Public Property Region Amazon.RegionEndpoint

The region to be used with this CredentialProfile

Public Property RequestMinCompressionSizeBytes System.Nullable<System.Int64>

Minimum size in bytes that a request body should be to trigger compression.

Public Property RetryMode System.Nullable<Amazon.Runtime.RequestRetryMode>

The request retry mode as legacy, standard, or adaptive

Public Property S3DisableExpressSessionAuth System.Nullable<System.Boolean>

Disables this client's usage of Session Auth for S3Express buckets and reverts to using conventional SigV4.

Public Property S3DisableMultiRegionAccessPoints System.Nullable<System.Boolean>

If true, the use of multi-region access points is disabled.

Public Property S3RegionalEndpoint System.Nullable<Amazon.Runtime.S3UsEast1RegionalEndpointValue>

The S3 Regional Endpoint Value as either legacy or regional

Public Property S3UseArnRegion System.Nullable<System.Boolean>

If true the region identified in the S3 access point arn will be used when making requests.

Public Property StsRegionalEndpoints System.Nullable<Amazon.Runtime.StsRegionalEndpointsValue>

The Sts Regional Endpoints Value as either legacy or regional

Public Property UseDualstackEndpoint System.Nullable<System.Boolean>

Configures the endpoint calculation to go to a dual stack (ipv6 enabled) endpoint for the configured region.

Public Property UseFIPSEndpoint System.Nullable<System.Boolean>

Configures the endpoint calculation to go to a FIPS ( endpoint for the configured region.



Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

Public Method 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.

Version Information

Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5