The options that are available for creating AWSCredentials with the AWSCredentialsFactory. The type of AWSCredentials that are created depends on which Options are set. Below are the different types of credentials returned, along with the options that are used to obtain them. ([] denotes options that are not required) BasicAWSCredentials AccessKey SecretKey SessionAWSCredentials AccessKey SecretKey Token AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] FederatedAWSCredentials EndpointName RoleArn [UserIdentity] SSO SsoAccountId SsoRegion SsoRoleName SsoStartUrl SsoSession (Not supported in .NET Framework 3.5)
Inheritance Hierarchy
Namespace: Amazon.Runtime.CredentialManagement
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public class CredentialProfileOptions
The CredentialProfileOptions type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CredentialProfileOptions() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AccessKey | System.String |
The access key to be used in the AWSCredentials. |
|
|
CredentialProcess | System.String |
Contains the executable information to be used by the process credential retriever to either fetch Basic or Session credentials |
|
|
CredentialSource | System.String |
The source of credentials to be used to obtain AWSCredentials. |
|
|
EndpointName | System.String |
The endpoint name to be used for federated AWSCredentials. |
|
|
EndpointUrl | System.String |
The global endpoint to use for a profile. Service specific endpoints will always override this value. |
|
|
ExternalID | System.String |
The external id to use in assume role AWSCredentials. |
|
|
MfaSerial | System.String |
The serial number of the MFA to use in assume role AWSCredentials. |
|
|
RoleArn | System.String |
The role ARN to use when creating assume role or federated AWSCredentials. |
|
|
RoleSessionName | System.String |
An identifier for the assumed role session. |
|
|
SecretKey | System.String |
The secret key to use when creating AWSCredentials. |
|
|
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. |
|
|
SourceProfile | System.String |
When this CredentialProfileOptions object references another CredentialProfile, the name of the referenced CredentialProfile. |
|
|
SsoAccountId | System.String |
The AWS account ID that temporary AWS credentials will be resolved for using AWS SSO. |
|
|
SsoRegion | System.String |
The AWS region where the SSO directory for Amazon.Runtime.CredentialManagement.CredentialProfileOptions.SsoStartUrl is hosted. |
|
|
SsoRegistrationScopes | System.String |
The SSO scopes that are provided for authorization when using AWS SSO. |
|
|
SsoRoleName | System.String |
The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for using AWS SSO. |
|
|
SsoSession | System.String |
Name of the Sso Session section used to retrieve Amazon.Runtime.CredentialManagement.CredentialProfileOptions.SsoRegion and Amazon.Runtime.CredentialManagement.CredentialProfileOptions.SsoStartUrl. |
|
|
SsoStartUrl | System.String |
The main URL for users to login to their SSO directory. Provided by the SSO service via the web console. |
|
|
Token | System.String |
The session token to be used to create AWSCredentials. |
|
|
UserIdentity | System.String |
The user identity to use when creating federated AWSCredentials. If not set, the user identity that the code is running under will be used. |
|
|
WebIdentityTokenFile | System.String |
Absolute path to the file on disk containing an OIDC token. |
Version Information
.NET:
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