Package software.amazon.awscdk.services.iam

Interface CfnAccessKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:18.014Z")
@Stability(Stable)
public interface CfnAccessKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccessKey.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 CfnAccessKeyProps cfnAccessKeyProps = CfnAccessKeyProps.builder()
         .userName("userName")
         // the properties below are optional
         .serial(123)
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccessKeyProps.Builder	A builder for CfnAccessKeyProps
static final class	CfnAccessKeyProps.Jsii$Proxy	An implementation for CfnAccessKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnAccessKeyProps.Builder	builder()
default Number	getSerial()	This value is specific to CloudFormation and can only be incremented .
default String	getStatus()	The status of the access key.
String	getUserName()	The name of the IAM user that the new key will belong to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserName

@Stability(Stable)
@NotNull
String getUserName()

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

See Also:

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

getSerial

@Stability(Stable)
@Nullable
default Number getSerial()

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.

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the access key.

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

See Also:

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

builder

@Stability(Stable)
static CfnAccessKeyProps.Builder builder()

Returns:

a CfnAccessKeyProps.Builder of CfnAccessKeyProps