Domain

• Implements: IDomain

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

Initializers

import com.aliyun.ros.cdk.apig.Domain;
Domain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .domainName(java.lang.String)
    .domainName(IResolvable)
    .protocol(java.lang.String)
    .protocol(IResolvable)
//  .certIdentifier(java.lang.String)
//  .certIdentifier(IResolvable)
//  .forceHttps(java.lang.Boolean)
//  .forceHttps(IResolvable)
//  .gatewayType(java.lang.String)
//  .gatewayType(IResolvable)
//  .http2Option(java.lang.String)
//  .http2Option(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tlsCipherSuitesConfig(IResolvable)
//  .tlsCipherSuitesConfig(TlsCipherSuitesConfigProperty)
//  .tlsMax(java.lang.String)
//  .tlsMax(IResolvable)
//  .tlsMin(java.lang.String)
//  .tlsMin(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

domainName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property domainName: The name of the Domain.

protocol^Required

• Type: java.lang.String OR com.aliyun.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.

certIdentifier^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property certIdentifier: The tls Certificate identification.

forceHttps^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

gatewayType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayType: The type of Gateway.

http2Option^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property http2Option: Whether to enable http2 settings.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tlsCipherSuitesConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR TlsCipherSuitesConfigProperty

Property tlsCipherSuitesConfig: The configuration of the TLS encryption suite.

tlsMax^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tlsMax: The maximum version of the TLS protocol.

The maximum version of the TLS protocol is 1.3.

tlsMin^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tlsMin: The minimum version of the TLS protocol.

The minimum version of the TLS protocol is 1.0.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.apig.Domain;
Domain.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCertIdentifier^Required

public java.lang.Object getAttrCertIdentifier();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CertIdentifier: The tls Certificate identification.

attrDomainId^Required

public java.lang.Object getAttrDomainId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DomainId: The ID of the Domain.

attrDomainName^Required

public java.lang.Object getAttrDomainName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DomainName: The name of the Domain.

attrForceHttps^Required

public java.lang.Object getAttrForceHttps();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHttp2Option^Required

public java.lang.Object getAttrHttp2Option();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Http2Option: Whether to enable http2 settings.

attrProtocol^Required

public java.lang.Object getAttrProtocol();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Protocol: The types of protocols.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrTlsCipherSuitesConfig^Required

public java.lang.Object getAttrTlsCipherSuitesConfig();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TlsCipherSuitesConfig: The configuration of the TLS encryption suite.

attrTlsMax^Required

public java.lang.Object getAttrTlsMax();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TlsMax: The maximum version of the TLS protocol.

The maximum version of the TLS protocol is 1.3.

attrTlsMin^Required

public java.lang.Object getAttrTlsMin();

• Type: java.lang.String OR com.aliyun.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

public DomainProps getProps();

• Type: DomainProps