software.amazon.awscdk.services.iam

Interface CfnAccessKeyProps

All Known Implementing Classes:

CfnAccessKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:04.613Z")
public interface CfnAccessKeyProps

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();
 

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 java.lang.Number	getSerial() This value is specific to CloudFormation and can only be *incremented* .
default java.lang.String	getStatus() The status of the access key.
java.lang.String	getUserName() The name of the IAM user that the new key will belong to.

Method Detail

getUserName

java.lang.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

default java.lang.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

default java.lang.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

static CfnAccessKeyProps.Builder builder()

Returns:

a CfnAccessKeyProps.Builder of CfnAccessKeyProps