Skip to content

Accelerator

This class encapsulates and extends the ROS resource type ALIYUN::GA::Accelerator, which is used to create a Global Accelerator (GA) instance.

Initializers

import { Accelerator } from '@alicloud/ros-cdk-ga'
new Accelerator(scope: Construct, id: string, props?: AcceleratorProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props AcceleratorProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsOptional


enableResourcePropertyConstraintOptional

  • Type: boolean

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

sessionRequired

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

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount

public addCount(count: number | IResolvable): void

countRequired

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

addDependency

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAcceleratorId string | @alicloud/ros-cdk-core.IResolvable Attribute AcceleratorId: The ID of the GA instance to query.
attrAcceleratorName string | @alicloud/ros-cdk-core.IResolvable Attribute AcceleratorName: The Name of the GA instance.
attrAutoPay string | @alicloud/ros-cdk-core.IResolvable Attribute AutoPay: The AutoPay of the GA instance.
attrAutoUseCoupon string | @alicloud/ros-cdk-core.IResolvable Attribute AutoUseCoupon: The AutoUseCoupon of the GA instance.
attrDnsName string | @alicloud/ros-cdk-core.IResolvable Attribute DnsName: The DNS name of the accelerator.
attrDuration string | @alicloud/ros-cdk-core.IResolvable Attribute Duration: The Duration of the GA instance.
attrOrderId string | @alicloud/ros-cdk-core.IResolvable Attribute OrderId: The OrderId of the GA instance.
attrPaymentType string | @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The Payment Typethe GA instance.
attrPricingCycle string | @alicloud/ros-cdk-core.IResolvable Attribute PricingCycle: The PricingCycle of the GA instance.
attrSpec string | @alicloud/ros-cdk-core.IResolvable Attribute Spec: The instance type of the GA instance.
props AcceleratorProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAcceleratorIdRequired

public readonly attrAcceleratorId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AcceleratorId: The ID of the GA instance to query.


attrAcceleratorNameRequired

public readonly attrAcceleratorName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AcceleratorName: The Name of the GA instance.


attrAutoPayRequired

public readonly attrAutoPay: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoPay: The AutoPay of the GA instance.


attrAutoUseCouponRequired

public readonly attrAutoUseCoupon: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoUseCoupon: The AutoUseCoupon of the GA instance.


attrDnsNameRequired

public readonly attrDnsName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DnsName: The DNS name of the accelerator.


attrDurationRequired

public readonly attrDuration: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Duration: The Duration of the GA instance.


attrOrderIdRequired

public readonly attrOrderId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: The OrderId of the GA instance.


attrPaymentTypeRequired

public readonly attrPaymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The Payment Typethe GA instance.


attrPricingCycleRequired

public readonly attrPricingCycle: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PricingCycle: The PricingCycle of the GA instance.


attrSpecRequired

public readonly attrSpec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Spec: The instance type of the GA instance.


propsRequired

public readonly props: AcceleratorProps;