Class CredentialProfile

Namespace

Amazon.Runtime.CredentialManagement

Assembly

AWSSDK.Core.dll

A named group of options that are persisted and used to obtain AWSCredentials.

public class CredentialProfile

Inheritance

object

CredentialProfile

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CredentialProfile(string, CredentialProfileOptions)

Construct a new CredentialProfile.

public CredentialProfile(string name, CredentialProfileOptions profileOptions)

Parameters

name string

profileOptions CredentialProfileOptions

Properties

CanCreateAWSCredentials

True if the properties of the Options object can be converted into AWSCredentials, false otherwise. See CredentialProfileOptions for more details about which options are available.

public bool CanCreateAWSCredentials { get; }

Property Value

bool

CredentialDescription

If CanCreateAWSCredentials is true, returns a short description of the type of credentials that would be created. If CanCreateAWSCredentials is false, return null.

public string CredentialDescription { get; }

Property Value

string

CredentialProfileStore

The ICredentialProfileStore that this CredentialProfile is associated with. Null if this CredentialProfile is not associated with a ICredentialProfileStore.

public ICredentialProfileStore CredentialProfileStore { get; }

Property Value

ICredentialProfileStore

DefaultConfigurationModeName

The desired Name that IDefaultConfigurationProvider should use.

If this is null/empty, then the Legacy Mode will be used.

public string DefaultConfigurationModeName { get; set; }

Property Value

string

EC2MetadataServiceEndpoint

Endpoint of the EC2 Instance Metadata Service

public string EC2MetadataServiceEndpoint { get; set; }

Property Value

string

EC2MetadataServiceEndpointMode

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

public EC2MetadataServiceEndpointMode? EC2MetadataServiceEndpointMode { get; set; }

Property Value

EC2MetadataServiceEndpointMode?

EndpointDiscoveryEnabled

The endpoint discovery enabled value for this CredentialProfile

public bool? EndpointDiscoveryEnabled { get; set; }

Property Value

bool?

MaxAttempts

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

public int? MaxAttempts { get; set; }

Property Value

int?

Name

The name of the CredentialProfile

public string Name { get; }

Property Value

string

Options

The options to be used to create AWSCredentials.

public CredentialProfileOptions Options { get; }

Property Value

CredentialProfileOptions

Region

The region to be used with this CredentialProfile

public RegionEndpoint Region { get; set; }

Property Value

RegionEndpoint

RetryMode

The request retry mode as legacy, standard, or adaptive

public RequestRetryMode? RetryMode { get; set; }

Property Value

RequestRetryMode?

S3DisableMultiRegionAccessPoints

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

public bool? S3DisableMultiRegionAccessPoints { get; set; }

Property Value

bool?

S3RegionalEndpoint

The S3 Regional Endpoint Value as either legacy or regional

public S3UsEast1RegionalEndpointValue? S3RegionalEndpoint { get; set; }

Property Value

S3UsEast1RegionalEndpointValue?

S3UseArnRegion

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

public bool? S3UseArnRegion { get; set; }

Property Value

bool?

StsRegionalEndpoints

The Sts Regional Endpoints Value as either legacy or regional

public StsRegionalEndpointsValue? StsRegionalEndpoints { get; set; }

Property Value

StsRegionalEndpointsValue?

UseDualstackEndpoint

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

public bool? UseDualstackEndpoint { get; set; }

Property Value

bool?

UseFIPSEndpoint

Configures the endpoint calculation to go to a FIPS (https://aws.amazon.com/compliance/fips/) endpoint for the configured region.

public bool? UseFIPSEndpoint { get; set; }

Property Value

bool?

Methods

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetAWSCredentials(ICredentialProfileSource)

Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise.

See CredentialProfileOptions for a list of AWSCredentials returned by this method.

public AWSCredentials GetAWSCredentials(ICredentialProfileSource profileSource)

Parameters

profileSource ICredentialProfileSource

The profile source, for profiles that reference other profiles.

Returns

AWSCredentials

AWSCredentials for this profile.

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string