Interface IAccessKeyProps
Properties for defining an IAM access key.
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public interface IAccessKeyProps
Syntax (vb)
Public Interface IAccessKeyProps
Remarks
ExampleMetadata: infused
Examples
// Creates a new IAM user, access and secret keys, and stores the secret access key in a Secret.
var user = new User(this, "User");
var accessKey = new AccessKey(this, "AccessKey", new AccessKeyProps { User = user });
var secretValue = SecretStringValueBeta1.FromToken(accessKey.SecretAccessKey.ToString());
new Secret(this, "Secret", new SecretProps {
SecretStringBeta1 = secretValue
});
Synopsis
Properties
Serial | A CloudFormation-specific value that signifies the access key should be replaced/rotated. |
Status | The status of the access key. |
User | The IAM user this key will belong to. |
Properties
Serial
A CloudFormation-specific value that signifies the access key should be replaced/rotated.
virtual Nullable<double> Serial { get; }
Property Value
System.Nullable<System.Double>
Remarks
This value can only be incremented. Incrementing this value will cause CloudFormation to replace the Access Key resource.
Default: - No serial value
Status
The status of the access key.
virtual Nullable<AccessKeyStatus> Status { get; }
Property Value
System.Nullable<AccessKeyStatus>
Remarks
An Active access key is allowed to be used to make API calls; An Inactive key cannot.
Default: - The access key is active
User
The IAM user this key will belong to.
IUser User { get; }
Property Value
Remarks
Changing this value will result in the access key being deleted and a new access key (with a different ID and secret value) being assigned to the new user.