Domain

• Implements: IDomain

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Domain, which is used to create a domain name.

Initializers

import ros_cdk_apig
ros_cdk_apig.Domain(
  scope: Construct,
  id: str,
  domain_name: typing.Union[str, IResolvable],
  protocol: typing.Union[str, IResolvable],
  cert_identifier: typing.Union[str, IResolvable] = None,
  force_https: typing.Union[bool, IResolvable] = None,
  gateway_type: typing.Union[str, IResolvable] = None,
  http2_option: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tls_cipher_suites_config: typing.Union[IResolvable, TlsCipherSuitesConfigProperty] = None,
  tls_max: typing.Union[str, IResolvable] = None,
  tls_min: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

domain_name^Required

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

Property domainName: The name of the Domain.

protocol^Required

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

Property protocol: The types of protocols supported by the domain are as follows: * HTTP: Supports only the HTTP protocol.

• HTTPS: Supports only the HTTPS protocol.

cert_identifier^Optional

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

Property certIdentifier: The tls Certificate identification.

force_https^Optional

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

Property forceHttps: Set the HTTPS protocol type and whether to enable forced HTTPS redirection.

gateway_type^Optional

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

Property gatewayType: The type of Gateway.

http2_option^Optional

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

Property http2Option: Whether to enable http2 settings.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

tls_cipher_suites_config^Optional

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

Property tlsCipherSuitesConfig: The configuration of the TLS encryption suite.

tls_max^Optional

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

Property tlsMax: The maximum version of the TLS protocol.

The maximum version of the TLS protocol is 1.3.

tls_min^Optional

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

Property tlsMin: The minimum version of the TLS protocol.

The minimum version of the TLS protocol is 1.0.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_apig
ros_cdk_apig.Domain.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cert_identifier^Required

attr_cert_identifier: typing.Union[str, IResolvable]

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

Attribute CertIdentifier: The tls Certificate identification.

attr_domain_id^Required

attr_domain_id: typing.Union[str, IResolvable]

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

Attribute DomainId: The ID of the Domain.

attr_domain_name^Required

attr_domain_name: typing.Union[str, IResolvable]

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

Attribute DomainName: The name of the Domain.

attr_force_https^Required

attr_force_https: typing.Union[str, IResolvable]

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

Attribute ForceHttps: Set the HTTPS protocol type and whether to enable forced HTTPS redirection.

attr_http2_option^Required

attr_http2_option: typing.Union[str, IResolvable]

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

Attribute Http2Option: Whether to enable http2 settings.

attr_protocol^Required

attr_protocol: typing.Union[str, IResolvable]

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

Attribute Protocol: The types of protocols.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_tls_cipher_suites_config^Required

attr_tls_cipher_suites_config: typing.Union[str, IResolvable]

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

Attribute TlsCipherSuitesConfig: The configuration of the TLS encryption suite.

attr_tls_max^Required

attr_tls_max: typing.Union[str, IResolvable]

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

Attribute TlsMax: The maximum version of the TLS protocol.

The maximum version of the TLS protocol is 1.3.

attr_tls_min^Required

attr_tls_min: typing.Union[str, IResolvable]

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

Attribute TlsMin: The minimum version of the TLS protocol.

The minimum version of the TLS protocol is 1.0.

props^Required

props: DomainProps

• Type: DomainProps