Skip to content

Domain

  • Implements: @alicloud/ros-cdk-apig.datasource.IDomain

This class encapsulates and extends the ROS resource type DATASOURCE::APIG::Domain.

Initializers

import { datasource } from '@alicloud/ros-cdk-apig'
new datasource.Domain(scope: Construct, id: string, props: DomainProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DomainProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { datasource } from '@alicloud/ros-cdk-apig'
datasource.Domain.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCertIdentifier string | @alicloud/ros-cdk-core.IResolvable Attribute CertIdentifier: The certificate ID.
attrDomainId string | @alicloud/ros-cdk-core.IResolvable Attribute DomainId: The ID of the domain.
attrDomainName string | @alicloud/ros-cdk-core.IResolvable Attribute DomainName: The domain name.
attrForceHttps string | @alicloud/ros-cdk-core.IResolvable Attribute ForceHttps: Set the HTTPS protocol type and whether to enable forced HTTPS redirection.
attrHttp2Option string | @alicloud/ros-cdk-core.IResolvable Attribute Http2Option: The HTTP/2 configuration.
attrProtocol string | @alicloud/ros-cdk-core.IResolvable Attribute Protocol: The supported protocol.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrTlsCipherSuitesConfig string | @alicloud/ros-cdk-core.IResolvable Attribute TlsCipherSuitesConfig: The TLS cipher suite configurations.
attrTlsMax string | @alicloud/ros-cdk-core.IResolvable Attribute TlsMax: The maximum version of the TLS protocol.
attrTlsMin string | @alicloud/ros-cdk-core.IResolvable Attribute TlsMin: The minimum version of the TLS protocol.
props DomainProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCertIdentifierRequired

public readonly attrCertIdentifier: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CertIdentifier: The certificate ID.


attrDomainIdRequired

public readonly attrDomainId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DomainId: The ID of the domain.


attrDomainNameRequired

public readonly attrDomainName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DomainName: The domain name.


attrForceHttpsRequired

public readonly attrForceHttps: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrHttp2OptionRequired

public readonly attrHttp2Option: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Http2Option: The HTTP/2 configuration.


attrProtocolRequired

public readonly attrProtocol: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Protocol: The supported protocol.


attrResourceGroupIdRequired

public readonly attrResourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrTlsCipherSuitesConfigRequired

public readonly attrTlsCipherSuitesConfig: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TlsCipherSuitesConfig: The TLS cipher suite configurations.


attrTlsMaxRequired

public readonly attrTlsMax: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TlsMax: The maximum version of the TLS protocol.

The maximum version of the TLS protocol is 1.3.


attrTlsMinRequired

public readonly attrTlsMin: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TlsMin: The minimum version of the TLS protocol.

The minimum version of the TLS protocol is 1.0.


propsRequired

public readonly props: DomainProps;