Skip to content

Domain

  • Implements: com.aliyun.ros.cdk.apig.datasource.IDomain

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

Initializers

import com.aliyun.ros.cdk.apig.datasource.Domain;
Domain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .domainId(java.lang.String)
    .domainId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
domainId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property domainId: The ID of the domain.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

domainIdRequired

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

Property domainId: The ID of the domain.


refreshOptionsOptional

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

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 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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • 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)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCertIdentifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CertIdentifier: The certificate ID.
attrDomainId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DomainId: The ID of the domain.
attrDomainName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DomainName: The domain name.
attrForceHttps 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Http2Option: The HTTP/2 configuration.
attrProtocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Protocol: The supported protocol.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrTlsCipherSuitesConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TlsCipherSuitesConfig: The TLS cipher suite configurations.
attrTlsMax java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TlsMax: The maximum version of the TLS protocol.
attrTlsMin java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TlsMin: The minimum version of the TLS protocol.
props DomainProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCertIdentifierRequired

public java.lang.Object getAttrCertIdentifier();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CertIdentifier: The certificate ID.


attrDomainIdRequired

public java.lang.Object getAttrDomainId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DomainId: The ID of the domain.


attrDomainNameRequired

public java.lang.Object getAttrDomainName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DomainName: The domain name.


attrForceHttpsRequired

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.


attrHttp2OptionRequired

public java.lang.Object getAttrHttp2Option();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Http2Option: The HTTP/2 configuration.


attrProtocolRequired

public java.lang.Object getAttrProtocol();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Protocol: The supported protocol.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrTlsCipherSuitesConfigRequired

public java.lang.Object getAttrTlsCipherSuitesConfig();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TlsCipherSuitesConfig: The TLS cipher suite configurations.


attrTlsMaxRequired

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.


attrTlsMinRequired

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.


propsRequired

public DomainProps getProps();