Class CfnAccessKeyProps

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

Properties for defining a CfnAccessKey.

public class CfnAccessKeyProps : ICfnAccessKeyProps

Inheritance

object

CfnAccessKeyProps

Implements

ICfnAccessKeyProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IAM;

             var cfnAccessKeyProps = new CfnAccessKeyProps {
                 UserName = "userName",

                 // the properties below are optional
                 Serial = 123,
                 Status = "status"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html

ExampleMetadata: fixture=_generated

Constructors

CfnAccessKeyProps()

public CfnAccessKeyProps()

Properties

Serial

This value is specific to CloudFormation and can only be incremented .

public double? Serial { get; set; }

Property Value

double?

Remarks

Incrementing this value notifies CloudFormation that you want to rotate your access key. When you update your stack, CloudFormation will replace the existing access key with a new key.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-serial

Status

The status of the access key.

public string? Status { get; set; }

Property Value

string

Remarks

Active means that the key is valid for API calls, while Inactive means it is not.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-status

UserName

The name of the IAM user that the new key will belong to.

public string UserName { get; set; }

Property Value

string

Remarks

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-username