Class CfnUser
Specifies a MemoryDB user.
Inherited Members
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUser : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnUser
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Authenticating users with Access Contol Lists (ACLs) .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html
CloudformationResource: AWS::MemoryDB::User
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.MemoryDB;
var authenticationMode;
var cfnUser = new CfnUser(this, "MyCfnUser", new CfnUserProps {
UserName = "userName",
// the properties below are optional
AccessString = "accessString",
AuthenticationMode = authenticationMode,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnUser(Construct, String, ICfnUserProps) |
Properties
AccessString | Access permissions string used for this user. |
AttrArn | When you pass the logical ID of this resource to the intrinsic |
AttrStatus | Indicates the user status. |
AuthenticationMode | Denotes whether the user requires a password to authenticate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
UserName | The name of the user. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnUser(Construct, String, ICfnUserProps)
public CfnUser(Construct scope, string id, ICfnUserProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUserProps
Resource properties.
Properties
AccessString
Access permissions string used for this user.
public virtual string AccessString { get; set; }
Property Value
System.String
AttrArn
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref returns the ARN of the user, such as arn:aws:memorydb:us-east-1:123456789012:user/user1
.
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
Valid values : active
| modifying
| deleting
CloudformationAttribute: Status
AuthenticationMode
Denotes whether the user requires a password to authenticate.
public virtual object AuthenticationMode { get; set; }
Property Value
System.Object
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
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
UserName
The name of the user.
public virtual string UserName { get; set; }
Property Value
System.String
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>