CustomDomain
- Implements: ICustomDomain
This class encapsulates and extends the ROS resource type ALIYUN::FC3::CustomDomain, which is used to create a custom domain name in Function Compute 3.0.
Initializers
import com.aliyun.ros.cdk.fc3.CustomDomain;
CustomDomain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.authConfig(IResolvable)
.authConfig(AuthConfigProperty)
.domainName(java.lang.String)
.domainName(IResolvable)
.protocol(java.lang.String)
.protocol(IResolvable)
// .certConfig(IResolvable)
// .certConfig(CertConfigProperty)
// .routeConfig(IResolvable)
// .routeConfig(RouteConfigProperty)
// .tlsConfig(IResolvable)
// .tlsConfig(TlsConfigProperty)
// .wafConfig(IResolvable)
// .wafConfig(WafConfigProperty)
.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. |
authConfig | com.aliyun.ros.cdk.core.IResolvable OR AuthConfigProperty | Property authConfig: Permission authentication configuration. |
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: Protocol types supported by the domain name. |
certConfig | com.aliyun.ros.cdk.core.IResolvable OR CertConfigProperty | Property certConfig: HTTPS certificate information. |
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. |
tlsConfig | com.aliyun.ros.cdk.core.IResolvable OR TlsConfigProperty | Property tlsConfig: TLS config. |
wafConfig | com.aliyun.ros.cdk.core.IResolvable OR WafConfigProperty | Property wafConfig: Web application firewall configuration information. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
authConfigRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR AuthConfigProperty
Property authConfig: Permission authentication configuration.
domainNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property domainName: Domain name.
Fill in the custom domain name that has been filed in Ali cloud or access to the record.
protocolRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocol: Protocol types supported by the domain name.
Valid values:
- HTTP: Only HTTP protocol is supported.
- HTTPS: HTTPS only is supported.
- HTTP,HTTPS: Supports HTTP and HTTPS protocols.
certConfigOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR CertConfigProperty
Property certConfig: HTTPS certificate information.
routeConfigOptional
- Type: 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.
tlsConfigOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR TlsConfigProperty
Property tlsConfig: TLS config.
wafConfigOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR WafConfigProperty
Property wafConfig: Web application firewall configuration information.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.fc3.CustomDomain;
CustomDomain.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrDomainName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DomainName: The domain name. |
props | CustomDomainProps | 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
attrDomainNameRequired
public java.lang.Object getAttrDomainName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DomainName: The domain name.
propsRequired
public CustomDomainProps getProps();
- Type: CustomDomainProps