CompressionRule

• Implements: ICompressionRule

This class encapsulates and extends the ROS resource type ALIYUN::ESA::CompressionRuleThe , which resource type creates a compression rule.

Initializers

import { CompressionRule } from '@alicloud/ros-cdk-esa'
new CompressionRule(scope: Construct, id: string, props: CompressionRuleProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: CompressionRuleProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { CompressionRule } from '@alicloud/ros-cdk-esa'
CompressionRule.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrBrotli^Required

public readonly attrBrotli: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Brotli: Brotli compression.

attrConfigId^Required

public readonly attrConfigId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConfigId: Config Id.

attrConfigType^Required

public readonly attrConfigType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConfigType: The type of the configuration.

attrGzip^Required

public readonly attrGzip: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Gzip: Gzip compression.

attrRule^Required

public readonly attrRule: string | IResolvable;

• Type: string | @alicloud/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 readonly attrRuleEnable: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute RuleEnable: Rule switch.

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

attrRuleName^Required

public readonly attrRuleName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute RuleName: Rule name.

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

attrSequence^Required

public readonly attrSequence: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Sequence: Order of rule execution.

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

attrSiteVersion^Required

public readonly attrSiteVersion: string | IResolvable;

• Type: string | @alicloud/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.

attrZstd^Required

public readonly attrZstd: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Zstd: Zstd compression.

props^Required

public readonly props: CompressionRuleProps;

• Type: CompressionRuleProps