Interface ICfnAccessKeyProps

Properties for defining a CfnAccessKey.

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnAccessKeyProps

Syntax (vb)

Public Interface ICfnAccessKeyProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html

ExampleMetadata: fixture=_generated

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

Synopsis

Properties

Serial	This value is specific to CloudFormation and can only be incremented .
Status	The status of the access key.
UserName	The name of the IAM user that the new key will belong to.

Properties

Serial

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

double? Serial { get; }

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.

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

Status

The status of the access key.

string? Status { get; }

Property Value

string

Remarks

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

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

UserName

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

string UserName { get; }

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: _+=,.@-

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