Skip to content

Domain

This class encapsulates and extends the ROS resource type ALIYUN::WAF::Domain, which is used to add a domain to Web Application Firewall (WAF).

Initializers

import ros_cdk_waf
ros_cdk_waf.Domain(
  scope: Construct,
  id: str,
  domain_name: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  is_access_product: typing.Union[str, IResolvable],
  source_ips: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  cluster_type: typing.Union[str, IResolvable] = None,
  connection_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  http2_port: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  http_port: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  https_port: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  https_redirect: typing.Union[str, IResolvable] = None,
  http_to_user_ip: typing.Union[str, IResolvable] = None,
  load_balancing: typing.Union[str, IResolvable] = None,
  log_headers: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LogHeadersProperty]]] = None,
  read_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  write_time: typing.Union[typing.Union[int, float], 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: Domain name.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: Instance id.
is_access_product typing.Union[str, ros_cdk_core.IResolvable] Property isAccessProduct: Is there a seven-layer agency before WAF.
source_ips typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property sourceIps: Back to source IP configuration.
cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterType: Cluster type.
connection_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property connectionTime: Connection timeout.
http2_port typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property http2Port: Http2 port configuration.
http_port typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property httpPort: Http port configuration.
https_port typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property httpsPort: Https port configuration.
https_redirect typing.Union[str, ros_cdk_core.IResolvable] Property httpsRedirect: Https forced redirect configuration.
http_to_user_ip typing.Union[str, ros_cdk_core.IResolvable] Property httpToUserIp: Http back to source.
load_balancing typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancing: Load balancing configuration.
log_headers typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LogHeadersProperty]]] Property logHeaders: Domain traffic tagging.
read_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property readTime: Read connection timeout period.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group Id.
write_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property writeTime: Write connection timeout period.
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: Domain name.


instance_idRequired

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

Property instanceId: Instance id.


is_access_productRequired

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

Property isAccessProduct: Is there a seven-layer agency before WAF.


source_ipsRequired

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

Property sourceIps: Back to source IP configuration.


cluster_typeOptional

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

Property clusterType: Cluster type.


connection_timeOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property connectionTime: Connection timeout.


http2_portOptional

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

Property http2Port: Http2 port configuration.


http_portOptional

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

Property httpPort: Http port configuration.


https_portOptional

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

Property httpsPort: Https port configuration.


https_redirectOptional

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

Property httpsRedirect: Https forced redirect configuration.


http_to_user_ipOptional

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

Property httpToUserIp: Http back to source.


load_balancingOptional

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

Property loadBalancing: Load balancing configuration.


log_headersOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LogHeadersProperty]]]

Property logHeaders: Domain traffic tagging.


read_timeOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property readTime: Read connection timeout period.


resource_group_idOptional

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

Property resourceGroupId: Resource group Id.


write_timeOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property writeTime: Write connection timeout period.


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.

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

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

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

import ros_cdk_waf
ros_cdk_waf.Domain.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.
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_cluster_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterType: Cluster type.
attr_cname typing.Union[str, ros_cdk_core.IResolvable] Attribute Cname: CNAME assigned by WAF instance.
attr_domain_name typing.Union[str, ros_cdk_core.IResolvable] Attribute DomainName: Domain name.
attr_http2_port typing.Union[str, ros_cdk_core.IResolvable] Attribute Http2Port: Http2 port configuration.
attr_http_port typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpPort: Http port configuration.
attr_https_port typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpsPort: Https port configuration.
attr_https_redirect typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpsRedirect: Https forced redirect configuration.
attr_http_to_user_ip typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpToUserIp: Http back to source.
attr_instance_id typing.Union[str, ros_cdk_core.IResolvable] Attribute InstanceId: Instance id.
attr_is_access_product typing.Union[str, ros_cdk_core.IResolvable] Attribute IsAccessProduct: Is there a seven-layer agency before WAF.
attr_load_balancing typing.Union[str, ros_cdk_core.IResolvable] Attribute LoadBalancing: Load balancing configuration.
attr_log_headers typing.Union[str, ros_cdk_core.IResolvable] Attribute LogHeaders: Domain traffic tagging.
attr_resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceGroupId: Resource group Id.
attr_source_ips typing.Union[str, ros_cdk_core.IResolvable] Attribute SourceIps: Back to source IP configuration.
attr_version typing.Union[str, ros_cdk_core.IResolvable] Attribute Version: Optimistic lock version.
props DomainProps 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_cluster_typeRequired

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

Attribute ClusterType: Cluster type.


attr_cnameRequired

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

Attribute Cname: CNAME assigned by WAF instance.


attr_domain_nameRequired

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

Attribute DomainName: Domain name.


attr_http2_portRequired

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

Attribute Http2Port: Http2 port configuration.


attr_http_portRequired

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

Attribute HttpPort: Http port configuration.


attr_https_portRequired

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

Attribute HttpsPort: Https port configuration.


attr_https_redirectRequired

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

Attribute HttpsRedirect: Https forced redirect configuration.


attr_http_to_user_ipRequired

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

Attribute HttpToUserIp: Http back to source.


attr_instance_idRequired

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

Attribute InstanceId: Instance id.


attr_is_access_productRequired

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

Attribute IsAccessProduct: Is there a seven-layer agency before WAF.


attr_load_balancingRequired

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

Attribute LoadBalancing: Load balancing configuration.


attr_log_headersRequired

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

Attribute LogHeaders: Domain traffic tagging.


attr_resource_group_idRequired

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

Attribute ResourceGroupId: Resource group Id.


attr_source_ipsRequired

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

Attribute SourceIps: Back to source IP configuration.


attr_versionRequired

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

Attribute Version: Optimistic lock version.


propsRequired

props: DomainProps