Class AccessKeyProps

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

Properties for defining an IAM access key.

public class AccessKeyProps : IAccessKeyProps

Inheritance

object

AccessKeyProps

Implements

IAccessKeyProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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
            });

Remarks

ExampleMetadata: infused

Constructors

AccessKeyProps()

public AccessKeyProps()

Properties

Serial

A CloudFormation-specific value that signifies the access key should be replaced/rotated.

public double? Serial { get; set; }

Property Value

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.

public AccessKeyStatus? Status { get; set; }

Property Value

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.

public IUser User { get; set; }

Property Value

IUser

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.