Skip to content

SecretParameter

This class encapsulates and extends the ROS resource type ALIYUN::OOS::SecretParameter, which is used to create an encryption parameter.

Initializers 

import ros_cdk_oos
ros_cdk_oos.SecretParameter(
  scope: Construct,
  id: str,
  secret_parameter_name: typing.Union[str, IResolvable],
  value: typing.Union[str, IResolvable],
  constraints: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  description: typing.Union[str, IResolvable] = None,
  key_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = 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 encryption parameter.
value typing.Union[str, ros_cdk_core.IResolvable] Property value: The value of the encryption parameter.
constraints typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property constraints: The constraints of the encryption parameter.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the encryption parameter.
key_id typing.Union[str, ros_cdk_core.IResolvable] Property keyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of resource group.
tags typing.List[TagsProperty] Property tags: Tags of encryption parameter.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

secret_parameter_nameRequired

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

Property secretParameterName: The name of the encryption parameter.

The name must be 1 to 180 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.

valueRequired

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

Property value: The value of the encryption parameter.

The value must be 1 to 4096 characters in length.

constraintsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property constraints: The constraints of the encryption parameter.

descriptionOptional

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

Property description: The description of the encryption parameter.

The description must be 1 to 200 characters in length.

key_idOptional

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

Property keyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.

resource_group_idOptional

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

Property resourceGroupId: The ID of resource group.

tagsOptional

Property tags: Tags of encryption parameter.

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 

import ros_cdk_oos
ros_cdk_oos.SecretParameter.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_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 Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
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 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 encryption 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: Tags of encryption parameter.
attr_type ros_cdk_core.IResolvable Attribute Type: The data type of the encryption 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.

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_constraintsRequired 

attr_constraints: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Constraints: The constraints of the encryption parameter.

attr_created_byRequired 

attr_created_by: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreatedBy: The user who created the encryption parameter.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the encryption parameter.

attr_key_idRequired 

attr_key_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute KeyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.

attr_parameter_versionRequired 

attr_parameter_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ParameterVersion: The version number of the encryption parameter.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of resource group.

attr_secret_parameter_idRequired 

attr_secret_parameter_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecretParameterId: The ID of the encryption parameter.

attr_secret_parameter_nameRequired 

attr_secret_parameter_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecretParameterName: The name of the encryption parameter.

attr_share_typeRequired 

attr_share_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ShareType: The share type of the encryption parameter.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: Tags of encryption parameter.

attr_typeRequired 

attr_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Type: The data type of the encryption parameter.

attr_updated_byRequired 

attr_updated_by: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdatedBy: The user who updated the encryption parameter.

attr_updated_dateRequired 

attr_updated_date: IResolvable
  • Type: ros_cdk_core.IResolvable

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