RosOriginRule

This class is a base encapsulation around the ROS resource type ALIYUN::ESA::OriginRule.

Initializers

import com.aliyun.ros.cdk.esa.RosOriginRule;
RosOriginRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .dnsRecord(java.lang.String)
//  .dnsRecord(IResolvable)
//  .follow302Enable(java.lang.String)
//  .follow302Enable(IResolvable)
//  .follow302MaxTries(java.lang.Number)
//  .follow302MaxTries(IResolvable)
//  .follow302RetainArgs(java.lang.String)
//  .follow302RetainArgs(IResolvable)
//  .follow302RetainHeader(java.lang.String)
//  .follow302RetainHeader(IResolvable)
//  .follow302TargetHost(java.lang.String)
//  .follow302TargetHost(IResolvable)
//  .originHost(java.lang.String)
//  .originHost(IResolvable)
//  .originHttpPort(java.lang.Number)
//  .originHttpPort(IResolvable)
//  .originHttpsPort(java.lang.Number)
//  .originHttpsPort(IResolvable)
//  .originMtls(java.lang.String)
//  .originMtls(IResolvable)
//  .originReadTimeout(java.lang.Number)
//  .originReadTimeout(IResolvable)
//  .originScheme(java.lang.String)
//  .originScheme(IResolvable)
//  .originSni(java.lang.String)
//  .originSni(IResolvable)
//  .originVerify(java.lang.String)
//  .originVerify(IResolvable)
//  .range(java.lang.String)
//  .range(IResolvable)
//  .rangeChunkSize(java.lang.String)
//  .rangeChunkSize(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();

scope^Required

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

scope in which this resource is defined.

id^Required

• Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

siteId^Required

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

dnsRecord^Optional

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

follow302Enable^Optional

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

follow302MaxTries^Optional

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

follow302RetainArgs^Optional

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

follow302RetainHeader^Optional

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

follow302TargetHost^Optional

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

originHost^Optional

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

originHttpPort^Optional

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

originHttpsPort^Optional

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

originMtls^Optional

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

originReadTimeout^Optional

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

originScheme^Optional

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

originSni^Optional

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

originVerify^Optional

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

range^Optional

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

rangeChunkSize^Optional

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

rule^Optional

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

ruleEnable^Optional

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

ruleName^Optional

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

sequence^Optional

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

siteVersion^Optional

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

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.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

addCondition

public void addCondition(RosCondition con)

con^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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: java.lang.String

The path of the value to delete.

addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

addMetaData

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: java.lang.String

The path to the property.

addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: java.lang.String

The path of the property.

value^Required

• Type: java.lang.Object

The value.

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

options^Optional

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

fetchCondition

public RosCondition fetchCondition()

fetchDesc

public java.lang.String fetchDesc()

fetchRosDependency

public java.util.List<java.lang.String> fetchRosDependency()

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: java.lang.String

The name of the attribute.

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.RosOriginRule;
RosOriginRule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.esa.RosOriginRule;
RosOriginRule.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.esa.RosOriginRule;
RosOriginRule.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

creationStack^Required

public java.util.List<java.lang.String> getCreationStack();

• Type: java.util.List

logicalId^Required

public java.lang.String getLogicalId();

• Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

public Stack getStack();

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

Options for this resource, such as condition, update policy etc.

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

attrConfigId^Required

public IResolvable getAttrConfigId();

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

attrConfigType^Required

public IResolvable getAttrConfigType();

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

attrDnsRecord^Required

public IResolvable getAttrDnsRecord();

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

attrFollow302Enable^Required

public IResolvable getAttrFollow302Enable();

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

attrFollow302MaxTries^Required

public IResolvable getAttrFollow302MaxTries();

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

attrFollow302RetainArgs^Required

public IResolvable getAttrFollow302RetainArgs();

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

attrFollow302RetainHeader^Required

public IResolvable getAttrFollow302RetainHeader();

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

attrFollow302TargetHost^Required

public IResolvable getAttrFollow302TargetHost();

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

attrOriginHost^Required

public IResolvable getAttrOriginHost();

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

attrOriginHttpPort^Required

public IResolvable getAttrOriginHttpPort();

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

attrOriginHttpsPort^Required

public IResolvable getAttrOriginHttpsPort();

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

attrOriginMtls^Required

public IResolvable getAttrOriginMtls();

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

attrOriginReadTimeout^Required

public IResolvable getAttrOriginReadTimeout();

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

attrOriginScheme^Required

public IResolvable getAttrOriginScheme();

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

attrOriginSni^Required

public IResolvable getAttrOriginSni();

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

attrOriginVerify^Required

public IResolvable getAttrOriginVerify();

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

attrRange^Required

public IResolvable getAttrRange();

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

attrRangeChunkSize^Required

public IResolvable getAttrRangeChunkSize();

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

attrRule^Required

public IResolvable getAttrRule();

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

attrRuleEnable^Required

public IResolvable getAttrRuleEnable();

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

attrRuleName^Required

public IResolvable getAttrRuleName();

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

attrSequence^Required

public IResolvable getAttrSequence();

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

attrSiteVersion^Required

public IResolvable getAttrSiteVersion();

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

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

siteId^Required

public java.lang.Object getSiteId();

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

dnsRecord^Optional

public java.lang.Object getDnsRecord();

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

follow302Enable^Optional

public java.lang.Object getFollow302Enable();

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

follow302MaxTries^Optional

public java.lang.Object getFollow302MaxTries();

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

follow302RetainArgs^Optional

public java.lang.Object getFollow302RetainArgs();

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

follow302RetainHeader^Optional

public java.lang.Object getFollow302RetainHeader();

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

follow302TargetHost^Optional

public java.lang.Object getFollow302TargetHost();

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

originHost^Optional

public java.lang.Object getOriginHost();

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

originHttpPort^Optional

public java.lang.Object getOriginHttpPort();

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

originHttpsPort^Optional

public java.lang.Object getOriginHttpsPort();

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

originMtls^Optional

public java.lang.Object getOriginMtls();

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

originReadTimeout^Optional

public java.lang.Object getOriginReadTimeout();

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

originScheme^Optional

public java.lang.Object getOriginScheme();

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

originSni^Optional

public java.lang.Object getOriginSni();

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

originVerify^Optional

public java.lang.Object getOriginVerify();

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

range^Optional

public java.lang.Object getRange();

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

rangeChunkSize^Optional

public java.lang.Object getRangeChunkSize();

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

rule^Optional

public java.lang.Object getRule();

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

ruleEnable^Optional

public java.lang.Object getRuleEnable();

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

ruleName^Optional

public java.lang.Object getRuleName();

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

sequence^Optional

public java.lang.Object getSequence();

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

siteVersion^Optional

public java.lang.Object getSiteVersion();

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.