Secret
- Implements: ISecret
This class encapsulates and extends the ROS resource type ALIYUN::SAE::Secret.
Initializers
import ros_cdk_sae
ros_cdk_sae.Secret(
scope: Construct,
id: str,
namespace_id: typing.Union[str, IResolvable],
secret_data: typing.Union[IResolvable, typing.Mapping[typing.Any]],
secret_name: typing.Union[str, IResolvable],
secret_type: typing.Union[str, IResolvable],
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
namespace_id | typing.Union[str, ros_cdk_core.IResolvable] | Property namespaceId: The namespace ID where the Secret instance resides. |
secret_data | typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] | Property secretData: Secret key-value pair data, required.The format is as follows: {"Data":"{"k1":"v1", "k2":"v2"}"} k represents the key and v represents the value. |
secret_name | typing.Union[str, ros_cdk_core.IResolvable] | Property secretName: Secret instance name.Allows combinations of numbers, letters, en dash (-) and underscores (_) and only start with letters. |
secret_type | typing.Union[str, ros_cdk_core.IResolvable] | Property secretType: The currently supported Secret instance type.The values are as follows: kubernetes.io\/dockerconfigjson: A confidential dictionary that stores the username and password of the mirror repository, used to pull mirror authentication during deployment. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
namespace_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property namespaceId: The namespace ID where the Secret instance resides.
If the namespace you are in is the default namespace, you just need to fill in the RegionId.
secret_dataRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property secretData: Secret key-value pair data, required.The format is as follows: {"Data":"{"k1":"v1", "k2":"v2"}"} k represents the key and v represents the value.
secret_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property secretName: Secret instance name.Allows combinations of numbers, letters, en dash (-) and underscores (_) and only start with letters.
secret_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property secretType: The currently supported Secret instance type.The values are as follows: kubernetes.io\/dockerconfigjson: A confidential dictionary that stores the username and password of the mirror repository, used to pull mirror authentication during deployment.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_sae
ros_cdk_sae.Secret.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_namespace_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute NamespaceId: The namespace ID that the Secret instance belongs to. |
attr_secret_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SecretId: The ID of the secret. |
props | SecretProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: ros_cdk_core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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_namespace_idRequired
attr_namespace_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute NamespaceId: The namespace ID that the Secret instance belongs to.
attr_secret_idRequired
attr_secret_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SecretId: The ID of the secret.
propsRequired
props: SecretProps
- Type: SecretProps