Class AccessKeyProps

Properties for defining an IAM access key.

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()

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AccessKeyProps : IAccessKeyProps

Syntax (vb)

Public Class AccessKeyProps Implements 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 secret = new Secret(this, "Secret", new SecretProps {
                SecretStringValue = accessKey.SecretAccessKey
            });

Synopsis

Constructors

AccessKeyProps()

Properties for defining an IAM access key.

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.

Constructors

AccessKeyProps()

Properties for defining an IAM access key.

public AccessKeyProps()

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 secret = new Secret(this, "Secret", new SecretProps {
                SecretStringValue = accessKey.SecretAccessKey
            });

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.

Implements

IAccessKeyProps