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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.932Z")
 @Stability(value=Stable)
public interface CfnAccessKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAccessKey`.

Example:

 // Creates a new IAM user, access and secret keys, and stores the secret access key in a Secret.
 User user = new User(this, "User");
 CfnAccessKey accessKey = CfnAccessKey.Builder.create(this, "AccessKey").userName(user.getUserName()).build();
 SecretStringValueBeta1 secretValue = SecretStringValueBeta1.fromToken(accessKey.getAttrSecretAccessKey());
 Secret.Builder.create(this, "Secret")
         .secretStringBeta1(secretValue)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getUserName

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

getSerial

@Stability(value=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.

getStatus

@Stability(value=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.

builder

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

Returns:

a CfnAccessKeyProps.Builder of CfnAccessKeyProps