Skip to content

DiskCategories

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::DiskCategories, which is used to query the information about disk categories.

Initializers

from ros_cdk_ecs import datasource
datasource.DiskCategories(
  scope: Construct,
  id: str,
  type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  data_disk_category: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  system_disk_category: 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.
type typing.Union[str, ros_cdk_core.IResolvable] Property type: The resource type to query.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone for which to query resources.
data_disk_category typing.Union[str, ros_cdk_core.IResolvable] Property dataDiskCategory: The category of the data disk.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The instance type.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
system_disk_category typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskCategory: The category of the system disk.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

typeRequired

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

Property type: The resource type to query.

If you set Type to data,you can specify the InstanceType parameter to disk. If you set Type to system, you must specify the InstanceType parameter. Valid values: system: system disk data: data disk


zone_idRequired

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

Property zoneId: The ID of the zone for which to query resources.


data_disk_categoryOptional

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

Property dataDiskCategory: The category of the data disk.

Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral_ssd: local SSD cloud_essd: ESSD


instance_typeOptional

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

Property instanceType: The instance type.

For more information,see Instance families or call the DescribeInstanceTypes,operation to query the most recent instance type list. When the Type parameter is set to system or data,you must set the InstanceType parameter.


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.

system_disk_categoryOptional

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

Property systemDiskCategory: The category of the system disk.

Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral_ssd: local SSD cloud_essd: ESSD


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_ecs import datasource
datasource.DiskCategories.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_disk_categories ros_cdk_core.IResolvable Attribute DiskCategories: The list of disk categories.
attr_disk_category_ids ros_cdk_core.IResolvable Attribute DiskCategoryIds: The list of disk category IDs.

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_disk_categoriesRequired

attr_disk_categories: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskCategories: The list of disk categories.


attr_disk_category_idsRequired

attr_disk_category_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskCategoryIds: The list of disk category IDs.