Skip to content

Secret

This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Secret.

Initializers 

from ros_cdk_kms import datasource
datasource.Secret(
  scope: Construct,
  id: str,
  secret_name: 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.
secret_name typing.Union[str, ros_cdk_core.IResolvable] Property secretName: The name of the secret.
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

secret_nameRequired

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

Property secretName: The name of the secret.

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_kms import datasource
datasource.Secret.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_arn ros_cdk_core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.
attr_automatic_rotation ros_cdk_core.IResolvable Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the secret was created.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the secret.
attr_dkms_instance_id ros_cdk_core.IResolvable Attribute DKMSInstanceId: The ID of the dedicated KMS instance.
attr_encryption_key_id ros_cdk_core.IResolvable Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value.
attr_extended_config ros_cdk_core.IResolvable Attribute ExtendedConfig: The extended configuration of the secret.
attr_last_rotation_date ros_cdk_core.IResolvable Attribute LastRotationDate: The time when the last rotation was performed.
attr_next_rotation_date ros_cdk_core.IResolvable Attribute NextRotationDate: The time when the next rotation will be performed.
attr_planned_delete_time ros_cdk_core.IResolvable Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.
attr_rotation_interval ros_cdk_core.IResolvable Attribute RotationInterval: The interval for automatic rotation.
attr_secret_name ros_cdk_core.IResolvable Attribute SecretName: The name of the secret.
attr_secret_type ros_cdk_core.IResolvable Attribute SecretType: The type of the secret.
attr_update_time ros_cdk_core.IResolvable Attribute UpdateTime: The time when the secret was updated.

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_arnRequired 

attr_arn: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.

attr_automatic_rotationRequired 

attr_automatic_rotation: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the secret was created.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the secret.

attr_dkms_instance_idRequired 

attr_dkms_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DKMSInstanceId: The ID of the dedicated KMS instance.

attr_encryption_key_idRequired 

attr_encryption_key_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value.

attr_extended_configRequired 

attr_extended_config: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExtendedConfig: The extended configuration of the secret.

attr_last_rotation_dateRequired 

attr_last_rotation_date: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LastRotationDate: The time when the last rotation was performed.

attr_next_rotation_dateRequired 

attr_next_rotation_date: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NextRotationDate: The time when the next rotation will be performed.

attr_planned_delete_timeRequired 

attr_planned_delete_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.

attr_rotation_intervalRequired 

attr_rotation_interval: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RotationInterval: The interval for automatic rotation.

The value is in the integer[unit] format. integer indicates the length of time. unit: indicates the time unit. The value of unit is fixed as s. For example, if the value is 604800s, automatic rotation is performed at a 7-day interval.The value is in the integer[unit] format. integer indicates the length of time. unit: indicates the time unit. The value of unit is fixed as s. For example, if the value is 604800s, automatic rotation is performed at a 7-day interval.

attr_secret_nameRequired 

attr_secret_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecretName: The name of the secret.

attr_secret_typeRequired 

attr_secret_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecretType: The type of the secret.

attr_update_timeRequired 

attr_update_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTime: The time when the secret was updated.