Skip to content

Zone

This class encapsulates and extends the ROS resource type DATASOURCE::PVTZ::Zone.

Initializers 

from ros_cdk_pvtz import datasource
datasource.Zone(
  scope: Construct,
  id: str,
  zone_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.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID.
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

zone_idRequired

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

Property zoneId: The zone ID.

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.
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_pvtz import datasource
datasource.Zone.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_bind_vpcs ros_cdk_core.IResolvable Attribute BindVpcs: The VPCs associated with the zone.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the zone was created.
attr_create_timestamp ros_cdk_core.IResolvable Attribute CreateTimestamp: The time when the zone was created.
attr_is_ptr ros_cdk_core.IResolvable Attribute IsPtr: Indicates whether the zone is a reverse lookup zone.
attr_proxy_pattern ros_cdk_core.IResolvable Attribute ProxyPattern: Indicates whether the recursive resolution proxy for subdomain names is enabled.
attr_record_count ros_cdk_core.IResolvable Attribute RecordCount: The total number of DNS records added in the zone.
attr_remark ros_cdk_core.IResolvable Attribute Remark: The description of the zone.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the zone belongs.
attr_slave_dns ros_cdk_core.IResolvable Attribute SlaveDns: Indicates whether the secondary Domain Name System (DNS) feature is enabled for the zone.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags of the zone.
attr_update_time ros_cdk_core.IResolvable Attribute UpdateTime: The time when the zone was last updated.
attr_update_timestamp ros_cdk_core.IResolvable Attribute UpdateTimestamp: The time when the zone was last updated.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The zone ID.
attr_zone_name ros_cdk_core.IResolvable Attribute ZoneName: The zone name.
attr_zone_tag ros_cdk_core.IResolvable Attribute ZoneTag: Not open to users for the time being, no value transfer is required.
attr_zone_type ros_cdk_core.IResolvable Attribute ZoneType: The zone type, temporarily closed to users, no need to pass values.

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_bind_vpcsRequired 

attr_bind_vpcs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BindVpcs: The VPCs associated with the zone.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the zone was created.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

attr_create_timestampRequired 

attr_create_timestamp: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTimestamp: The time when the zone was created.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

attr_is_ptrRequired 

attr_is_ptr: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsPtr: Indicates whether the zone is a reverse lookup zone.

attr_proxy_patternRequired 

attr_proxy_pattern: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProxyPattern: Indicates whether the recursive resolution proxy for subdomain names is enabled.

attr_record_countRequired 

attr_record_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RecordCount: The total number of DNS records added in the zone.

attr_remarkRequired 

attr_remark: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Remark: The description of the zone.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the zone belongs.

attr_slave_dnsRequired 

attr_slave_dns: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SlaveDns: Indicates whether the secondary Domain Name System (DNS) feature is enabled for the zone.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the zone.

attr_update_timeRequired 

attr_update_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTime: The time when the zone was last updated.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

attr_update_timestampRequired 

attr_update_timestamp: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTimestamp: The time when the zone was last updated.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: The zone ID.

attr_zone_nameRequired 

attr_zone_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneName: The zone name.

attr_zone_tagRequired 

attr_zone_tag: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneTag: Not open to users for the time being, no value transfer is required.

attr_zone_typeRequired 

attr_zone_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneType: The zone type, temporarily closed to users, no need to pass values.