DeploymentSet
- Implements: ros_cdk_ecs.datasource.IDeploymentSet
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::DeploymentSet, which is used to query the information about a deployment set.
Initializers
from ros_cdk_ecs import datasource
datasource.DeploymentSet(
scope: Construct,
id: str,
deployment_set_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. |
deployment_set_id | typing.Union[str, ros_cdk_core.IResolvable] | Property deploymentSetId: The ID of deployment set. |
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
deployment_set_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property deploymentSetId: The ID of deployment set.
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. |
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
from ros_cdk_ecs import datasource
datasource.DeploymentSet.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_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The time when the deployment set was created. |
attr_deployment_set_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeploymentSetId: The ID of deployment set. |
attr_deployment_set_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeploymentSetName: The name of the deployment set. |
attr_granularity | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Granularity: The deployment granularity. |
attr_group_count | typing.Union[str, ros_cdk_core.IResolvable] | Attribute GroupCount: The number of deployment set groups in the deployment set. |
attr_instance_amount | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceAmount: The number of instances in the deployment set. |
attr_instance_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceIds: The IDs of the instances in the deployment set. |
attr_strategy | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Strategy: The deployment strategy. |
props | DeploymentSetProps | 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_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The time when the deployment set was created.
attr_deployment_set_idRequired
attr_deployment_set_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeploymentSetId: The ID of deployment set.
attr_deployment_set_nameRequired
attr_deployment_set_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeploymentSetName: The name of the deployment set.
attr_granularityRequired
attr_granularity: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Granularity: The deployment granularity.
attr_group_countRequired
attr_group_count: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute GroupCount: The number of deployment set groups in the deployment set.
attr_instance_amountRequired
attr_instance_amount: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceAmount: The number of instances in the deployment set.
attr_instance_idsRequired
attr_instance_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceIds: The IDs of the instances in the deployment set.
attr_strategyRequired
attr_strategy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Strategy: The deployment strategy.
propsRequired
props: DeploymentSetProps
- Type: DeploymentSetProps