Skip to content

Account

This class encapsulates and extends the ROS resource type DATASOURCE::REDIS::Account.

Initializers

from ros_cdk_redis import datasource
datasource.Account(
  scope: Construct,
  id: str,
  account_name: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
account_name typing.Union[str, ros_cdk_core.IResolvable] Property accountName: The name of the account that you want to query.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the Redis instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

account_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountName: The name of the account that you want to query.


instance_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of the Redis instance.


refresh_optionsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

from ros_cdk_redis import datasource
datasource.Account.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_account_name ros_cdk_core.IResolvable Attribute AccountName: The name of the account.
attr_account_privilege ros_cdk_core.IResolvable Attribute AccountPrivilege: The permission of the account.
attr_account_type ros_cdk_core.IResolvable Attribute AccountType: The type of the account.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the account.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the Redis instance.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_account_nameRequired

attr_account_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountName: The name of the account.


attr_account_privilegeRequired

attr_account_privilege: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountPrivilege: The permission of the account.

Default value: RoleReadWrite. Valid values: RoleReadOnly: The account has the read-only permissions. RoleReadWrite: The account has the read and write permissions.


attr_account_typeRequired

attr_account_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountType: The type of the account.

Valid values: Normal: standard account Super: super account


attr_descriptionRequired

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the account.


attr_instance_idRequired

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the Redis instance.