CfnUserPropsMixin

class aws_cdk.mixins_preview.aws_elasticache.mixins.CfnUserPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html
CloudformationResource:: AWS::ElastiCache::User
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_elasticache import mixins as elasticache_mixins

# authentication_mode: Any

cfn_user_props_mixin = elasticache_mixins.CfnUserPropsMixin(elasticache_mixins.CfnUserMixinProps(
    access_string="accessString",
    authentication_mode=authentication_mode,
    engine="engine",
    no_password_required=False,
    passwords=["passwords"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_id="userId",
    user_name="userName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ElastiCache::User.

Parameters:

props (Union[CfnUserMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessString', 'authenticationMode', 'engine', 'noPasswordRequired', 'passwords', 'tags', 'userId', 'userName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AuthenticationModeProperty

class CfnUserPropsMixin.AuthenticationModeProperty(*, passwords=None, type=None)

Bases: object

Specifies the authentication mode to use.

Parameters:

passwords (Optional[Sequence[str]]) – Specifies the passwords to use for authentication if Type is set to password .
type (Optional[str]) – Specifies the authentication type. Possible options are IAM authentication, password and no password.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_elasticache import mixins as elasticache_mixins

authentication_mode_property = elasticache_mixins.CfnUserPropsMixin.AuthenticationModeProperty(
    passwords=["passwords"],
    type="type"
)

Attributes

passwords

Specifies the passwords to use for authentication if Type is set to password .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-passwords

type

Specifies the authentication type.

Possible options are IAM authentication, password and no password.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-type