Skip to content

CustomDomain

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

Initializers

import com.aliyun.ros.cdk.fc.CustomDomain;
CustomDomain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .domainName(java.lang.String)
    .domainName(IResolvable)
    .protocol(java.lang.String)
    .protocol(IResolvable)
//  .apiVersion(java.lang.String)
//  .apiVersion(IResolvable)
//  .certConfig(IResolvable)
//  .certConfig(CertConfigProperty)
//  .routeConfig(IResolvable)
//  .routeConfig(RouteConfigProperty)
    .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.
domainName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property domainName: domain name.
protocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protocol: HTTP or HTTP,HTTPS.
apiVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property apiVersion: api version.
certConfig com.aliyun.ros.cdk.core.IResolvable OR CertConfigProperty Property certConfig: certificate info.
routeConfig com.aliyun.ros.cdk.core.IResolvable OR RouteConfigProperty Property routeConfig: Routing table: path to function mappingwhen a function is called with a custom domain name.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

domainNameRequired

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

Property domainName: domain name.


protocolRequired

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

Property protocol: HTTP or HTTP,HTTPS.


apiVersionOptional

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

Property apiVersion: api version.


certConfigOptional

Property certConfig: certificate info.


routeConfigOptional

Property routeConfig: Routing table: path to function mappingwhen a function is called with a custom domain name.


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

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.fc.CustomDomain;
CustomDomain.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.
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.
attrDomain com.aliyun.ros.cdk.core.IResolvable Attribute Domain: The domain with protocol.
attrDomainName com.aliyun.ros.cdk.core.IResolvable Attribute DomainName: The domain name.

nodeRequired

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

The construct tree node associated with this construct.


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

attrDomainRequired

public IResolvable getAttrDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Domain: The domain with protocol.


attrDomainNameRequired

public IResolvable getAttrDomainName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DomainName: The domain name.