Skip to content

HttpsApplicationConfiguration

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

Initializers

import com.aliyun.ros.cdk.esa.HttpsApplicationConfiguration;
HttpsApplicationConfiguration.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .altSvc(java.lang.String)
//  .altSvc(IResolvable)
//  .altSvcClear(java.lang.String)
//  .altSvcClear(IResolvable)
//  .altSvcMa(java.lang.String)
//  .altSvcMa(IResolvable)
//  .altSvcPersist(java.lang.String)
//  .altSvcPersist(IResolvable)
//  .hsts(java.lang.String)
//  .hsts(IResolvable)
//  .hstsIncludeSubdomains(java.lang.String)
//  .hstsIncludeSubdomains(IResolvable)
//  .hstsMaxAge(java.lang.String)
//  .hstsMaxAge(IResolvable)
//  .hstsPreload(java.lang.String)
//  .hstsPreload(IResolvable)
//  .httpsForce(java.lang.String)
//  .httpsForce(IResolvable)
//  .httpsForceCode(java.lang.String)
//  .httpsForceCode(IResolvable)
//  .httpsNoSniDeny(java.lang.String)
//  .httpsNoSniDeny(IResolvable)
//  .httpsSniVerify(java.lang.String)
//  .httpsSniVerify(IResolvable)
//  .httpsSniWhitelist(java.lang.String)
//  .httpsSniWhitelist(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(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)
//  .siteVersion(java.lang.Number)
//  .siteVersion(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.
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: The site ID, which can be obtained by calling the ListSites API.
altSvc java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property altSvc: Function switch, default off.
altSvcClear java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property altSvcClear: Alt-Svc whether The header contains the clear parameter.
altSvcMa java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property altSvcMa: The effective time of the Alt-Svc, in seconds.
altSvcPersist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property altSvcPersist: Alt-Svc whether The header contains the persist parameter.
hsts java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hsts: Whether to enable HSTS.
hstsIncludeSubdomains java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hstsIncludeSubdomains: Whether to include subdomains in HSTS is disabled by default.
hstsMaxAge java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hstsMaxAge: The expiration time of HSTS, in seconds.
hstsPreload java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hstsPreload: Whether to enable HSTS preloading.
httpsForce java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpsForce: Whether to enable forced HTTPS.
httpsForceCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpsForceCode: Forced HTTPS jump status code, value range: 301 302 307 308.
httpsNoSniDeny java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpsNoSniDeny: Whether to enable to reject TLS handshake requests without SNI.
httpsSniVerify java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpsSniVerify: Whether to enable SNI verification.
httpsSniWhitelist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpsSniWhitelist: Specifies the list of allowed SNI whitelists, separated by spaces.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: Payment Type.
rule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rule: Rule content, using conditional expressions to match user requests.
ruleEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleEnable: Rule switch.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: Rule name.
sequence java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sequence: Order of rule execution.
siteVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteVersion: The version number of the site configuration.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

siteIdRequired

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

Property siteId: The site ID, which can be obtained by calling the ListSites API.


altSvcOptional

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

Property altSvc: Function switch, default off.

Value range: on: Enabled. off: Disabled.


altSvcClearOptional

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

Property altSvcClear: Alt-Svc whether The header contains the clear parameter.

This parameter is disabled by default. Value range: on: Enabled. off: Disabled.


altSvcMaOptional

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

Property altSvcMa: The effective time of the Alt-Svc, in seconds.

The default value is 86400 seconds.


altSvcPersistOptional

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

Property altSvcPersist: Alt-Svc whether The header contains the persist parameter.

This parameter is disabled by default. Value range: on: Enabled. off: Disabled.


hstsOptional

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

Property hsts: Whether to enable HSTS.

It is disabled by default. Value range: on: Enabled. off: Disabled.


hstsIncludeSubdomainsOptional

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

Property hstsIncludeSubdomains: Whether to include subdomains in HSTS is disabled by default.

Value range: on: Enabled. off: Disabled.


hstsMaxAgeOptional

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

Property hstsMaxAge: The expiration time of HSTS, in seconds.


hstsPreloadOptional

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

Property hstsPreload: Whether to enable HSTS preloading.

It is disabled by default. Value range: on: Enabled. off: Disabled.


httpsForceOptional

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

Property httpsForce: Whether to enable forced HTTPS.

It is disabled by default. Value range: on: Enabled. off: Disabled.


httpsForceCodeOptional

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

Property httpsForceCode: Forced HTTPS jump status code, value range: 301 302 307 308.


httpsNoSniDenyOptional

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

Property httpsNoSniDeny: Whether to enable to reject TLS handshake requests without SNI.

This parameter is disabled by default. Value range: on: Enabled. off: Disabled.


httpsSniVerifyOptional

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

Property httpsSniVerify: Whether to enable SNI verification.

It is disabled by default. Value range: on: Enabled. off: Disabled.


httpsSniWhitelistOptional

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

Property httpsSniWhitelist: Specifies the list of allowed SNI whitelists, separated by spaces.


paymentTypeOptional

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

Property paymentType: Payment Type.


ruleOptional

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


ruleEnableOptional

  • 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: Enabled. off: Disabled.


ruleNameOptional

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


sequenceOptional

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


siteVersionOptional

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

Property siteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.


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.esa.HttpsApplicationConfiguration;
HttpsApplicationConfiguration.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.
attrAltSvc java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AltSvc: Function switch, default off.
attrAltSvcClear java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AltSvcClear: Alt-Svc whether The header contains the clear parameter.
attrAltSvcMa java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AltSvcMa: The effective time of the Alt-Svc, in seconds.
attrAltSvcPersist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AltSvcPersist: Alt-Svc whether The header contains the persist parameter.
attrConfigId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigId: Config Id.
attrConfigType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigType: The type of the configuration.
attrHsts java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Hsts: Whether to enable HSTS.
attrHstsIncludeSubdomains java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HstsIncludeSubdomains: Whether to include subdomains in HSTS is disabled by default.
attrHstsMaxAge java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HstsMaxAge: The expiration time of HSTS, in seconds.
attrHstsPreload java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HstsPreload: Whether to enable HSTS preloading.
attrHttpsForce java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpsForce: Whether to enable forced HTTPS.
attrHttpsForceCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpsForceCode: Forced HTTPS jump status code, value range:.
attrHttpsNoSniDeny java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpsNoSniDeny: Whether to enable to reject TLS handshake requests without SNI.
attrHttpsSniVerify java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpsSniVerify: Whether to enable SNI verification.
attrHttpsSniWhitelist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpsSniWhitelist: Specifies the list of allowed SNI whitelists, separated by spaces.
attrRule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Rule: Rule content, using conditional expressions to match user requests.
attrRuleEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RuleEnable: Rule switch.
attrRuleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RuleName: Rule name.
attrSequence java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Sequence: Order of rule execution.
attrSiteVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SiteVersion: The version number of the site configuration.
props HttpsApplicationConfigurationProps 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

attrAltSvcRequired

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

Attribute AltSvc: Function switch, default off.


attrAltSvcClearRequired

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

Attribute AltSvcClear: Alt-Svc whether The header contains the clear parameter.

This parameter is disabled by default.


attrAltSvcMaRequired

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

Attribute AltSvcMa: The effective time of the Alt-Svc, in seconds.

The default value is 86400 seconds.


attrAltSvcPersistRequired

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

Attribute AltSvcPersist: Alt-Svc whether The header contains the persist parameter.

This parameter is disabled by default.


attrConfigIdRequired

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

Attribute ConfigId: Config Id.


attrConfigTypeRequired

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

Attribute ConfigType: The type of the configuration.


attrHstsRequired

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

Attribute Hsts: Whether to enable HSTS.

It is disabled by default.


attrHstsIncludeSubdomainsRequired

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

Attribute HstsIncludeSubdomains: Whether to include subdomains in HSTS is disabled by default.


attrHstsMaxAgeRequired

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

Attribute HstsMaxAge: The expiration time of HSTS, in seconds.


attrHstsPreloadRequired

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

Attribute HstsPreload: Whether to enable HSTS preloading.

It is disabled by default.


attrHttpsForceRequired

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

Attribute HttpsForce: Whether to enable forced HTTPS.

It is disabled by default.


attrHttpsForceCodeRequired

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

Attribute HttpsForceCode: Forced HTTPS jump status code, value range:.


attrHttpsNoSniDenyRequired

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

Attribute HttpsNoSniDeny: Whether to enable to reject TLS handshake requests without SNI.

This parameter is disabled by default.


attrHttpsSniVerifyRequired

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

Attribute HttpsSniVerify: Whether to enable SNI verification.

It is disabled by default.


attrHttpsSniWhitelistRequired

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

Attribute HttpsSniWhitelist: Specifies the list of allowed SNI whitelists, separated by spaces.


attrRuleRequired

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.


attrRuleEnableRequired

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.


attrRuleNameRequired

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.


attrSequenceRequired

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.


attrSiteVersionRequired

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

Attribute SiteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.


propsRequired

public HttpsApplicationConfigurationProps getProps();