Package software.amazon.awscdk.services.elasticache

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.elasticache.CfnUser
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.508Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable
A CloudFormation AWS::ElastiCache::User.

For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC) .

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.elasticache.*;
 Object authenticationMode;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .engine("engine")
         .userId("userId")
         .userName("userName")
         // the properties below are optional
         .accessString("accessString")
         .authenticationMode(authenticationMode)
         .noPasswordRequired(false)
         .passwords(List.of("passwords"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserProps props)
      Create a new AWS::ElastiCache::User.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the user.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Indicates the user status.

      Can be "active", "modifying" or "deleting".

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      AWS::ElastiCache::User.Tags.

    • getAuthenticationMode

      @Stability(Stable) @NotNull public Object getAuthenticationMode()
      Specifies the authentication mode to use. Below is an example of the possible JSON values:. 

       { Type: <iam | no-password-required | password> Passwords: ["*****", "******"] // If Type is password.
 }

    • setAuthenticationMode

      @Stability(Stable) public void setAuthenticationMode(@NotNull Object value)
      Specifies the authentication mode to use. Below is an example of the possible JSON values:. 

       { Type: <iam | no-password-required | password> Passwords: ["*****", "******"] // If Type is password.
 }

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The current supported value is redis.

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The current supported value is redis.

    • getUserId

      @Stability(Stable) @NotNull public String getUserId()
      The ID of the user.

    • setUserId

      @Stability(Stable) public void setUserId(@NotNull String value)
      The ID of the user.

    • getUserName

      @Stability(Stable) @NotNull public String getUserName()
      The username of the user.

    • setUserName

      @Stability(Stable) public void setUserName(@NotNull String value)
      The username of the user.

    • getAccessString

      @Stability(Stable) @Nullable public String getAccessString()
      Access permissions string used for this user.

    • setAccessString

      @Stability(Stable) public void setAccessString(@Nullable String value)
      Access permissions string used for this user.

    • getNoPasswordRequired

      @Stability(Stable) @Nullable public Object getNoPasswordRequired()
      Indicates a password is not required for this user.

    • setNoPasswordRequired

      @Stability(Stable) public void setNoPasswordRequired(@Nullable Boolean value)
      Indicates a password is not required for this user.

    • setNoPasswordRequired

      @Stability(Stable) public void setNoPasswordRequired(@Nullable IResolvable value)
      Indicates a password is not required for this user.

    • getPasswords

      @Stability(Stable) @Nullable public List<String> getPasswords()
      Passwords used for this user.

      You can create up to two passwords for each user.

    • setPasswords

      @Stability(Stable) public void setPasswords(@Nullable List<String> value)
      Passwords used for this user.

      You can create up to two passwords for each user.