Interface CfnAccessKeyProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.226Z") @Stability(Stable) public interface CfnAccessKeyProps extends
Properties for defining a CfnAccessKey.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnAccessKeyProps cfnAccessKeyProps = CfnAccessKeyProps.builder()
         // the properties below are optional
  • 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: _+=,.@-

    • 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.

    • 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.

    • builder

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