SecretParameter

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::SecretParameter.

Initializers

from ros_cdk_oos import datasource
datasource.SecretParameter(
  scope: Construct,
  id: str,
  secret_parameter_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_parameter_name	typing.Union[str, ros_cdk_core.IResolvable]	Property secretParameterName: The name of the parameter.
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.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

secret_parameter_name^Required

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

Property secretParameterName: The name of the parameter.

---

refresh_options^Optional

• 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_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

from ros_cdk_oos import datasource
datasource.SecretParameter.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_constraints	ros_cdk_core.IResolvable	Attribute Constraints: The constraints of the encryption parameter.
attr_created_by	ros_cdk_core.IResolvable	Attribute CreatedBy: The user who created the encryption parameter.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the encryption parameter was created.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the encryption parameter.
attr_key_id	ros_cdk_core.IResolvable	Attribute KeyId: The ID of the key of Key Management Service (KMS) that is used for encryption.
attr_parameter_version	ros_cdk_core.IResolvable	Attribute ParameterVersion: The version number of the encryption parameter.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.
attr_secret_parameter_id	ros_cdk_core.IResolvable	Attribute SecretParameterId: The ID of the encryption parameter.
attr_secret_parameter_name	ros_cdk_core.IResolvable	Attribute SecretParameterName: The name of the parameter.
attr_share_type	ros_cdk_core.IResolvable	Attribute ShareType: The share type of the encryption parameter.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tags of the parameter.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of the parameter.
attr_updated_by	ros_cdk_core.IResolvable	Attribute UpdatedBy: The user who updated the encryption parameter.
attr_updated_date	ros_cdk_core.IResolvable	Attribute UpdatedDate: The time when the encryption parameter was updated.
attr_value	ros_cdk_core.IResolvable	Attribute Value: The value of the encryption parameter.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_constraints^Required

attr_constraints: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Constraints: The constraints of the encryption parameter.

---

attr_created_by^Required

attr_created_by: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreatedBy: The user who created the encryption parameter.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the encryption parameter was created.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the encryption parameter.

---

attr_key_id^Required

attr_key_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute KeyId: The ID of the key of Key Management Service (KMS) that is used for encryption.

---

attr_parameter_version^Required

attr_parameter_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterVersion: The version number of the encryption parameter.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

---

attr_secret_parameter_id^Required

attr_secret_parameter_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecretParameterId: The ID of the encryption parameter.

---

attr_secret_parameter_name^Required

attr_secret_parameter_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecretParameterName: The name of the parameter.

---

attr_share_type^Required

attr_share_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ShareType: The share type of the encryption parameter.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the parameter.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of the parameter.

---

attr_updated_by^Required

attr_updated_by: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UpdatedBy: The user who updated the encryption parameter.

---

attr_updated_date^Required

attr_updated_date: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UpdatedDate: The time when the encryption parameter was updated.

---

attr_value^Required

attr_value: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Value: The value of the encryption parameter.

---