RosOriginRule

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Esa;
new RosOriginRule(Construct Scope, string Id, RosOriginRuleProps Props, bool EnableResourcePropertyConstraint);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.

Id^Required

• Type: string

scoped id of the resource.

Props^Required

• Type: RosOriginRuleProps

resource properties.

EnableResourcePropertyConstraint^Required

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

AddCondition

private void AddCondition(RosCondition Con)

Con^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

AddDependsOn

private 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: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

AddOverride

private void AddOverride(string Path, 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: 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: object

The value.

Could be primitive or complex.

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

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

PropertyPath^Required

• Type: string

The path to the property.

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

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

PropertyPath^Required

• Type: string

The path of the property.

Value^Required

• Type: object

The value.

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

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

Policy^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

Options^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

FetchCondition

private RosCondition FetchCondition()

FetchDesc

private string FetchDesc()

FetchRosDependency

private string[] FetchRosDependency()

GetAtt

private Reference GetAtt(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: string

The name of the attribute.

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Esa;
RosOriginRule.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Esa;
RosOriginRule.IsRosElement(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: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Esa;
RosOriginRule.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

LogicalId^Required

public string LogicalId { get; }

• Type: 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 Stack { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: 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 RosOptions { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

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

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

AttrConfigId^Required

public IResolvable AttrConfigId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrConfigType^Required

public IResolvable AttrConfigType { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDnsRecord^Required

public IResolvable AttrDnsRecord { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFollow302Enable^Required

public IResolvable AttrFollow302Enable { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFollow302MaxTries^Required

public IResolvable AttrFollow302MaxTries { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFollow302RetainArgs^Required

public IResolvable AttrFollow302RetainArgs { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFollow302RetainHeader^Required

public IResolvable AttrFollow302RetainHeader { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFollow302TargetHost^Required

public IResolvable AttrFollow302TargetHost { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginHost^Required

public IResolvable AttrOriginHost { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginHttpPort^Required

public IResolvable AttrOriginHttpPort { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginHttpsPort^Required

public IResolvable AttrOriginHttpsPort { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginMtls^Required

public IResolvable AttrOriginMtls { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginReadTimeout^Required

public IResolvable AttrOriginReadTimeout { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginScheme^Required

public IResolvable AttrOriginScheme { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginSni^Required

public IResolvable AttrOriginSni { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOriginVerify^Required

public IResolvable AttrOriginVerify { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRange^Required

public IResolvable AttrRange { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRangeChunkSize^Required

public IResolvable AttrRangeChunkSize { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRule^Required

public IResolvable AttrRule { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRuleEnable^Required

public IResolvable AttrRuleEnable { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRuleName^Required

public IResolvable AttrRuleName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSequence^Required

public IResolvable AttrSequence { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSiteVersion^Required

public IResolvable AttrSiteVersion { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

SiteId^Required

public object SiteId { get; }

• Type: object

DnsRecord^Optional

public object DnsRecord { get; }

• Type: object

Follow302Enable^Optional

public object Follow302Enable { get; }

• Type: object

Follow302MaxTries^Optional

public object Follow302MaxTries { get; }

• Type: object

Follow302RetainArgs^Optional

public object Follow302RetainArgs { get; }

• Type: object

Follow302RetainHeader^Optional

public object Follow302RetainHeader { get; }

• Type: object

Follow302TargetHost^Optional

public object Follow302TargetHost { get; }

• Type: object

OriginHost^Optional

public object OriginHost { get; }

• Type: object

OriginHttpPort^Optional

public object OriginHttpPort { get; }

• Type: object

OriginHttpsPort^Optional

public object OriginHttpsPort { get; }

• Type: object

OriginMtls^Optional

public object OriginMtls { get; }

• Type: object

OriginReadTimeout^Optional

public object OriginReadTimeout { get; }

• Type: object

OriginScheme^Optional

public object OriginScheme { get; }

• Type: object

OriginSni^Optional

public object OriginSni { get; }

• Type: object

OriginVerify^Optional

public object OriginVerify { get; }

• Type: object

Range^Optional

public object Range { get; }

• Type: object

RangeChunkSize^Optional

public object RangeChunkSize { get; }

• Type: object

Rule^Optional

public object Rule { get; }

• Type: object

RuleEnable^Optional

public object RuleEnable { get; }

• Type: object

RuleName^Optional

public object RuleName { get; }

• Type: object

Sequence^Optional

public object Sequence { get; }

• Type: object

SiteVersion^Optional

public object SiteVersion { get; }

• Type: object

Constants

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.