Package software.amazon.awscdk.cfnpropertymixins.services.iam

Class CfnAccessKeyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iam.CfnAccessKeyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessKeyPropsMixin>

Enclosing class:

CfnAccessKeyPropsMixin

@Stability(Stable)
public static final class CfnAccessKeyPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccessKeyPropsMixin>

A fluent builder for CfnAccessKeyPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAccessKeyPropsMixin	build()
static CfnAccessKeyPropsMixin.Builder	create()
static CfnAccessKeyPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAccessKeyPropsMixin.Builder	serial(Number serial)	This value is specific to CloudFormation and can only be incremented .
CfnAccessKeyPropsMixin.Builder	status(String status)	The status of the access key.
CfnAccessKeyPropsMixin.Builder	userName(String userName)	The name of the IAM user that the new key will belong to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccessKeyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAccessKeyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAccessKeyPropsMixin.Builder create()

Returns:

a new instance of CfnAccessKeyPropsMixin.Builder.

serial

@Stability(Stable)
public CfnAccessKeyPropsMixin.Builder serial(Number serial)

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

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.

Parameters:

serial - This value is specific to CloudFormation and can only be incremented . This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnAccessKeyPropsMixin.Builder status(String status)

The status of the access key.

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

Parameters:

status - The status of the access key. This parameter is required.

Returns:

this

See Also:

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

userName

@Stability(Stable)
public CfnAccessKeyPropsMixin.Builder userName(String userName)

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

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

Parameters:

userName - The name of the IAM user that the new key will belong to. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccessKeyPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccessKeyPropsMixin>

Returns:

a newly built instance of CfnAccessKeyPropsMixin.