Class CfnAccessKey

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAccessKey

Implements

IInspectable

IAccessKeyRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccessKey : CfnResource, IInspectable, IAccessKeyRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnAccessKey Inherits CfnResource Implements IInspectable, IAccessKeyRef, IConstruct, IDependable, IEnvironmentAware

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

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 cfnAccessKey = new CfnAccessKey(this, "MyCfnAccessKey", new CfnAccessKeyProps {
                 UserName = "userName",

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

Synopsis

Constructors

CfnAccessKey(Construct, string, ICfnAccessKeyProps)

Create a new AWS::IAM::AccessKey.

Properties

AccessKeyRef	A reference to a AccessKey resource.
AttrId	The ID for this access key.
AttrSecretAccessKey	Returns the secret access key for the specified AWS::IAM::AccessKey resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnAccessKey(object)	Checks whether the given object is a CfnAccessKey.
RenderProperties(IDictionary<string, object>)	Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.

Constructors

CfnAccessKey(Construct, string, ICfnAccessKeyProps)

Create a new AWS::IAM::AccessKey.

public CfnAccessKey(Construct scope, string id, ICfnAccessKeyProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnAccessKeyProps: Resource properties.

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

Properties

AccessKeyRef

A reference to a AccessKey resource.

public virtual IAccessKeyReference AccessKeyRef { get; }

Property Value

IAccessKeyReference

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

AttrId

The ID for this access key.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrSecretAccessKey

Returns the secret access key for the specified AWS::IAM::AccessKey resource.

public virtual string AttrSecretAccessKey { get; }

Property Value

string

Remarks

For example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY.

CloudformationAttribute: SecretAccessKey

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

Serial

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

public virtual double? Serial { get; set; }

Property Value

double?

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

Status

The status of the access key.

public virtual string? Status { get; set; }

Property Value

string

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

UserName

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

public virtual string UserName { get; set; }

Property Value

string

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

IsCfnAccessKey(object)

Checks whether the given object is a CfnAccessKey.

public static bool IsCfnAccessKey(object x)

Parameters

x object

Returns

bool

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

The default status for new keys is Active .

For information about quotas on the number of keys you can create, see IAM and AWS STS quotas in the IAM User Guide .

To ensure the security of your AWS account , the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can rotate access keys by increasing the value of the <code>serial</code> property.

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

CloudformationResource: AWS::IAM::AccessKey

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAccessKeyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware