HttpsBasicConfiguration

• Implements: IHttpsBasicConfiguration

This class encapsulates and extends the ROS resource type ALIYUN::ESA::HttpsBasicConfiguration.

Initializers

import com.aliyun.ros.cdk.esa.HttpsBasicConfiguration;
HttpsBasicConfiguration.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .ciphersuite(java.lang.String)
//  .ciphersuite(IResolvable)
//  .ciphersuiteGroup(java.lang.String)
//  .ciphersuiteGroup(IResolvable)
//  .http2(java.lang.String)
//  .http2(IResolvable)
//  .http3(java.lang.String)
//  .http3(IResolvable)
//  .https(java.lang.String)
//  .https(IResolvable)
//  .ocspStapling(java.lang.String)
//  .ocspStapling(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .sequence(java.lang.Number)
//  .sequence(IResolvable)
//  .tls10(java.lang.String)
//  .tls10(IResolvable)
//  .tls11(java.lang.String)
//  .tls11(IResolvable)
//  .tls12(java.lang.String)
//  .tls12(IResolvable)
//  .tls13(java.lang.String)
//  .tls13(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

siteId^Required

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

Property siteId: Site ID, which can be obtained by calling the ListSites interface.

ciphersuite^Optional

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

Property ciphersuite: Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.

ciphersuiteGroup^Optional

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

Property ciphersuiteGroup: Cipher suite group.

Default is all cipher suites. Possible values:

• all: All cipher suites.
• strict: Strong cipher suites.
• custom: Custom cipher suites.

http2^Optional

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

Property http2: Indicates whether HTTP2 is enabled.

Default is on. Possible values:

• on: Enabled.
• off: Disabled.

http3^Optional

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

Property http3: Whether to enable HTTP3, which is enabled by default.

The value can be:

• on: Enabled.
• off: Disabled.

https^Optional

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

Property https: Whether to enable HTTPS.

Default is enabled. Possible values:

• on: Enable.
• off: Disable.

ocspStapling^Optional

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

Property ocspStapling: Indicates whether OCSP is enabled.

Default is off. Possible values:

• on: Enabled.
• off: Disabled.

rule^Optional

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

Property rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set. There are two usage scenarios:

• Match all incoming requests: value set to true
• Match specified request: Set the value to a custom expression, for example: (http.host eq "video.example.com").

ruleEnable^Optional

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

Property ruleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set. Value range:

• on: open.
• off: close.

ruleName^Optional

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

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.

sequence^Optional

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

Property sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.

tls10^Optional

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

Property tls10: Whether to enable TLS1.0. Default is disabled. Possible values: - on: Enable. - off: Disable.

tls11^Optional

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

Property tls11: Whether to enable TLS1.1. Default is enabled. Possible values: - on: Enable. - off: Disable.

tls12^Optional

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

Property tls12: Whether to enable TLS1.2. Default is enabled. Possible values: - on: Enable. - off: Disable.

tls13^Optional

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

Property tls13: Whether to enable TLS1.3. Default is enabled. Possible values: - on: Enable. - off: Disable.

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.esa.HttpsBasicConfiguration;
HttpsBasicConfiguration.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

attrCiphersuite^Required

public java.lang.Object getAttrCiphersuite();

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

Attribute Ciphersuite: Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.

attrCiphersuiteGroup^Required

public java.lang.Object getAttrCiphersuiteGroup();

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

Attribute CiphersuiteGroup: Cipher suite group.

Default is all cipher suites.

attrConfigId^Required

public java.lang.Object getAttrConfigId();

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

Attribute ConfigId: ConfigId of the configuration.

attrConfigType^Required

public java.lang.Object getAttrConfigType();

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

Attribute ConfigType: Configuration type, which can be used to query global or rule configurations.

attrHttp2^Required

public java.lang.Object getAttrHttp2();

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

Attribute Http2: Indicates whether HTTP2 is enabled.

Default is on.

attrHttp3^Required

public java.lang.Object getAttrHttp3();

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

Attribute Http3: Whether to enable HTTP3, which is enabled by default.

attrHttps^Required

public java.lang.Object getAttrHttps();

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

Attribute Https: Whether to enable HTTPS.

Default is enabled.

attrOcspStapling^Required

public java.lang.Object getAttrOcspStapling();

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

Attribute OcspStapling: Indicates whether OCSP is enabled.

Default is off.

attrRule^Required

public java.lang.Object getAttrRule();

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

Attribute Rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set.

attrRuleEnable^Required

public java.lang.Object getAttrRuleEnable();

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

Attribute RuleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set.

attrRuleName^Required

public java.lang.Object getAttrRuleName();

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

Attribute RuleName: Rule name.

When adding global configuration, this parameter does not need to be set.

attrSequence^Required

public java.lang.Object getAttrSequence();

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

Attribute Sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.

attrTls10^Required

public java.lang.Object getAttrTls10();

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

Attribute Tls10: Whether to enable TLS1.0. Default is disabled.

attrTls11^Required

public java.lang.Object getAttrTls11();

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

Attribute Tls11: Whether to enable TLS1.1. Default is enabled.

attrTls12^Required

public java.lang.Object getAttrTls12();

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

Attribute Tls12: Whether to enable TLS1.2. Default is enabled.

attrTls13^Required

public java.lang.Object getAttrTls13();

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

Attribute Tls13: Whether to enable TLS1.3. Default is enabled.

props^Required

public HttpsBasicConfigurationProps getProps();

• Type: HttpsBasicConfigurationProps