DomainRecords
- Implements: ros_cdk_dns.datasource.IDomainRecords
This class encapsulates and extends the ROS resource type DATASOURCE::DNS::DomainRecords, which is used to query Domain Name System (DNS) records.
Initializers
from ros_cdk_dns import datasource
datasource.DomainRecords(
scope: Construct,
id: str,
domain_name: typing.Union[str, IResolvable],
direction: typing.Union[str, IResolvable] = None,
group_id: typing.Union[str, IResolvable] = None,
key_word: typing.Union[str, IResolvable] = None,
lang: typing.Union[str, IResolvable] = None,
line: typing.Union[str, IResolvable] = None,
order_by: typing.Union[str, IResolvable] = None,
refresh_options: typing.Union[str, IResolvable] = None,
rr_key_word: typing.Union[str, IResolvable] = None,
search_mode: typing.Union[str, IResolvable] = None,
status: typing.Union[str, IResolvable] = None,
type: typing.Union[str, IResolvable] = None,
type_key_word: typing.Union[str, IResolvable] = None,
value_key_word: 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. |
domain_name | typing.Union[str, ros_cdk_core.IResolvable] | Property domainName: The domain name for which you want to query DNS records. |
direction | typing.Union[str, ros_cdk_core.IResolvable] | Property direction: The order in which the returned DNS records are sorted. |
group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property groupId: The ID of the domain name group. |
key_word | typing.Union[str, ros_cdk_core.IResolvable] | Property keyWord: The keyword for searches in "%KeyWord%" mode. |
lang | typing.Union[str, ros_cdk_core.IResolvable] | Property lang: The language type. |
line | typing.Union[str, ros_cdk_core.IResolvable] | Property line: The line based on which the system queries DNS records. |
order_by | typing.Union[str, ros_cdk_core.IResolvable] | Property orderBy: The method that is used to sort the returned DNS records. |
refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
rr_key_word | typing.Union[str, ros_cdk_core.IResolvable] | Property rrKeyWord: The resource record (RR) keyword based on which the system queries DNS records. |
search_mode | typing.Union[str, ros_cdk_core.IResolvable] | Property searchMode: The search mode. |
status | typing.Union[str, ros_cdk_core.IResolvable] | Property status: The status of the DNS records to query. |
type | typing.Union[str, ros_cdk_core.IResolvable] | Property type: The type of the DNS records to query. |
type_key_word | typing.Union[str, ros_cdk_core.IResolvable] | Property typeKeyWord: The type keyword based on which the system queries DNS records. |
value_key_word | typing.Union[str, ros_cdk_core.IResolvable] | Property valueKeyWord: The record value keyword based on which the system queries DNS records. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
domain_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property domainName: The domain name for which you want to query DNS records.
directionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property direction: The order in which the returned DNS records are sorted.
group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property groupId: The ID of the domain name group.
key_wordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property keyWord: The keyword for searches in "%KeyWord%" mode.
The value is not case-sensitive.
langOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property lang: The language type.
lineOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property line: The line based on which the system queries DNS records.
order_byOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property orderBy: The method that is used to sort the returned DNS records.
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.
rr_key_wordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property rrKeyWord: The resource record (RR) keyword based on which the system queries DNS records.
search_modeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property searchMode: The search mode.
statusOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property status: The status of the DNS records to query.
typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property type: The type of the DNS records to query.
type_key_wordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property typeKeyWord: The type keyword based on which the system queries DNS records.
value_key_wordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property valueKeyWord: The record value keyword based on which the system queries DNS records.
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_dns import datasource
datasource.DomainRecords.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_domain_record_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DomainRecordIds: The list of The DNS domain record ids. |
attr_domain_records | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DomainRecords: The information about DNS records. |
props | DomainRecordsProps | 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_domain_record_idsRequired
attr_domain_record_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DomainRecordIds: The list of The DNS domain record ids.
attr_domain_recordsRequired
attr_domain_records: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DomainRecords: The information about DNS records.
propsRequired
props: DomainRecordsProps
- Type: DomainRecordsProps