Class CfnUser
A CloudFormation AWS::ElastiCache::User
.
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.AWS.ElastiCache.dll
Syntax (csharp)
public class CfnUser : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUser
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC) .
CloudformationResource: AWS::ElastiCache::User
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;
var authenticationMode;
var cfnUser = new CfnUser(this, "MyCfnUser", new CfnUserProps {
Engine = "engine",
UserId = "userId",
UserName = "userName",
// the properties below are optional
AccessString = "accessString",
AuthenticationMode = authenticationMode,
NoPasswordRequired = false,
Passwords = new [] { "passwords" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnUser(Construct, String, ICfnUserProps) | Create a new |
CfnUser(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUser(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccessString | Access permissions string used for this user. |
AttrArn | The Amazon Resource Name (ARN) of the user. |
AttrStatus | Indicates the user status. |
AuthenticationMode | Specifies the authentication mode to use. Below is an example of the possible JSON values:. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Engine | The current supported value is redis. |
NoPasswordRequired | Indicates a password is not required for this user. |
Passwords | Passwords used for this user. |
Tags |
|
UserId | The ID of the user. |
UserName | The username of the user. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUser(Construct, String, ICfnUserProps)
Create a new AWS::ElastiCache::User
.
public CfnUser(Construct scope, string id, ICfnUserProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserProps
- resource properties.
CfnUser(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUser(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUser(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUser(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessString
Access permissions string used for this user.
public virtual string AccessString { get; set; }
Property Value
System.String
Remarks
AttrArn
The Amazon Resource Name (ARN) of the user.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrStatus
Indicates the user status.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
Can be "active", "modifying" or "deleting".
CloudformationAttribute: Status
AuthenticationMode
Specifies the authentication mode to use. Below is an example of the possible JSON values:.
public virtual object AuthenticationMode { get; set; }
Property Value
System.Object
Remarks
{ Type: <iam | no-password-required | password> Passwords: ["*****", "******"] // If Type is password.
}
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Engine
The current supported value is redis.
public virtual string Engine { get; set; }
Property Value
System.String
Remarks
NoPasswordRequired
Indicates a password is not required for this user.
public virtual object NoPasswordRequired { get; set; }
Property Value
System.Object
Remarks
Passwords
Passwords used for this user.
public virtual string[] Passwords { get; set; }
Property Value
System.String[]
Remarks
You can create up to two passwords for each user.
Tags
AWS::ElastiCache::User.Tags
.
public virtual TagManager Tags { get; }
Property Value
Remarks
UserId
The ID of the user.
public virtual string UserId { get; set; }
Property Value
System.String
Remarks
UserName
The username of the user.
public virtual string UserName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>