Class CfnUser

For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnUser

Implements

IInspectable

IUserRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUser : CfnResource, IInspectable, IUserRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnUser Inherits CfnResource Implements IInspectable, IUserRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::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.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 AWS::ElastiCache::User.

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.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .
CfnPropertyNames	For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .
Engine	The current supported values are valkey and redis.
NoPasswordRequired	Indicates a password is not required for this user.
Passwords	Passwords used for this user.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The list of tags.
UserId	The ID of the user.
UserName	The username of the user.
UserRef	A reference to a User resource.

Methods

ArnForUser(IUserRef)	For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnUser(object)	Checks whether the given object is a CfnUser.
RenderProperties(IDictionary<string, object>)	For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

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 string

Construct identifier for this resource (unique in its scope).

props ICfnUserProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

Properties

AccessString

Access permissions string used for this user.

public virtual string? AccessString { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

AttrArn

The Amazon Resource Name (ARN) of the user.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrStatus

Indicates the user status.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

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

CloudformationAttribute: Status

AuthenticationMode

Specifies the authentication mode to use.

public virtual object AuthenticationMode { get; set; }

Property Value

object

Remarks

Below is an example of the possible JSON values:.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

CfnProperties

For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

CfnPropertyNames

For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

Engine

The current supported values are valkey and redis.

public virtual string Engine { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

NoPasswordRequired

Indicates a password is not required for this user.

public virtual object? NoPasswordRequired { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

Passwords

Passwords used for this user.

public virtual string[]? Passwords { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

TagsRaw

The list of tags.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

UserId

The ID of the user.

public virtual string UserId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

UserName

The username of the user.

public virtual string UserName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

UserRef

A reference to a User resource.

public virtual IUserReference UserRef { get; }

Property Value

IUserReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

Methods

ArnForUser(IUserRef)

For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

public static string ArnForUser(IUserRef resource)

Parameters

resource IUserRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::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.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"
                 } }
             });

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

IsCfnUser(object)

Checks whether the given object is a CfnUser.

public static bool IsCfnUser(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see Using Role Based Access Control (RBAC) .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

CloudformationResource: AWS::ElastiCache::User

ExampleMetadata: fixture=_generated

Implements

IInspectable

IUserRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable