Skip to content

Address

This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Address, which is used to query the information about a created elastic IP address (EIP).

Initializers 

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

scopeRequired

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

idRequired

  • Type: string

propsRequired

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

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 { datasource } from '@alicloud/ros-cdk-vpc'
datasource.Address.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.
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.
attrAddressName @alicloud/ros-cdk-core.IResolvable Attribute AddressName: The name of the EIP.
attrAllocationId @alicloud/ros-cdk-core.IResolvable Attribute AllocationId: The ID of the EIP instance.
attrBandwidth @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: The peak bandwidth of the EIP.
attrBandwidthPackageBandwidth @alicloud/ros-cdk-core.IResolvable Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP.
attrBandwidthPackageId @alicloud/ros-cdk-core.IResolvable Attribute BandwidthPackageId: The ID of the added shared bandwidth.
attrBandwidthPackageType @alicloud/ros-cdk-core.IResolvable Attribute BandwidthPackageType: The type of bandwidth.
attrBusinessStatus @alicloud/ros-cdk-core.IResolvable Attribute BusinessStatus: The business status of the EIP instance.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the EIP was created.
attrDeletionProtection @alicloud/ros-cdk-core.IResolvable Attribute DeletionProtection: Whether the delete protection function is turned on.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the EIP instance.
attrEipBandwidth @alicloud/ros-cdk-core.IResolvable Attribute EipBandwidth: AN EIP is added to an Internet shared bandwidth before or exit purchase an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.
attrHasReservationData @alicloud/ros-cdk-core.IResolvable Attribute HasReservationData: Whether there is renewal data.
attrHdMonitorStatus @alicloud/ros-cdk-core.IResolvable Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the current bound instance.
attrInstanceRegionId @alicloud/ros-cdk-core.IResolvable Attribute InstanceRegionId: The region ID of the currently bound resource.
attrInstanceType @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: The type of the current bound instance.
attrIpAddress @alicloud/ros-cdk-core.IResolvable Attribute IpAddress: The IP address of the EIP.
attrIsp @alicloud/ros-cdk-core.IResolvable Attribute Isp: Service providers.
attrNetmode @alicloud/ros-cdk-core.IResolvable Attribute Netmode: Network type.
attrOperationLocks @alicloud/ros-cdk-core.IResolvable Attribute OperationLocks: Lock details.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The billing method of the EIP.
attrPublicIpAddressPoolId @alicloud/ros-cdk-core.IResolvable Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs.
attrReservationActiveTime @alicloud/ros-cdk-core.IResolvable Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.
attrReservationBandwidth @alicloud/ros-cdk-core.IResolvable Attribute ReservationBandwidth: Renewal bandwidth, in Mbps.
attrReservationInternetChargeType @alicloud/ros-cdk-core.IResolvable Attribute ReservationInternetChargeType: Renewal Payment type.
attrReservationOrderType @alicloud/ros-cdk-core.IResolvable Attribute ReservationOrderType: Renewal order type.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSecondLimited @alicloud/ros-cdk-core.IResolvable Attribute SecondLimited: Whether a secondary speed limit is configured.
attrSecurityProtectionTypes @alicloud/ros-cdk-core.IResolvable Attribute SecurityProtectionTypes: Security protection level.
attrSegmentInstanceId @alicloud/ros-cdk-core.IResolvable Attribute SegmentInstanceId: The ID of the consecutive EIPs.
attrServiceManaged @alicloud/ros-cdk-core.IResolvable Attribute ServiceManaged: Indicates the resource created for the service account.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tag of the resource.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrAddressNameRequired 

public readonly attrAddressName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AddressName: The name of the EIP.

attrAllocationIdRequired 

public readonly attrAllocationId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AllocationId: The ID of the EIP instance.

attrBandwidthRequired 

public readonly attrBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Bandwidth: The peak bandwidth of the EIP.

Unit: Mbps.

attrBandwidthPackageBandwidthRequired 

public readonly attrBandwidthPackageBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP.

The unit is Mbps.

attrBandwidthPackageIdRequired 

public readonly attrBandwidthPackageId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthPackageId: The ID of the added shared bandwidth.

attrBandwidthPackageTypeRequired 

public readonly attrBandwidthPackageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthPackageType: The type of bandwidth.

Only CommonBandwidthPackage (shared bandwidth) is supported.

attrBusinessStatusRequired 

public readonly attrBusinessStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BusinessStatus: The business status of the EIP instance.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the EIP was created.

attrDeletionProtectionRequired 

public readonly attrDeletionProtection: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeletionProtection: Whether the delete protection function is turned on.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the EIP instance.

attrEipBandwidthRequired 

public readonly attrEipBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EipBandwidth: AN EIP is added to an Internet shared bandwidth before or exit purchase an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.

attrHasReservationDataRequired 

public readonly attrHasReservationData: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HasReservationData: Whether there is renewal data.

attrHdMonitorStatusRequired 

public readonly attrHdMonitorStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the current bound instance.

attrInstanceRegionIdRequired 

public readonly attrInstanceRegionId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceRegionId: The region ID of the currently bound resource.

attrInstanceTypeRequired 

public readonly attrInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceType: The type of the current bound instance.

attrIpAddressRequired 

public readonly attrIpAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpAddress: The IP address of the EIP.

attrIspRequired 

public readonly attrIsp: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Isp: Service providers.

attrNetmodeRequired 

public readonly attrNetmode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Netmode: Network type.

attrOperationLocksRequired 

public readonly attrOperationLocks: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OperationLocks: Lock details.

attrPaymentTypeRequired 

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

Attribute PaymentType: The billing method of the EIP.

attrPublicIpAddressPoolIdRequired 

public readonly attrPublicIpAddressPoolId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs.

attrReservationActiveTimeRequired 

public readonly attrReservationActiveTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.

attrReservationBandwidthRequired 

public readonly attrReservationBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReservationBandwidth: Renewal bandwidth, in Mbps.

attrReservationInternetChargeTypeRequired 

public readonly attrReservationInternetChargeType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReservationInternetChargeType: Renewal Payment type.

attrReservationOrderTypeRequired 

public readonly attrReservationOrderType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReservationOrderType: Renewal order type.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSecondLimitedRequired 

public readonly attrSecondLimited: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecondLimited: Whether a secondary speed limit is configured.

attrSecurityProtectionTypesRequired 

public readonly attrSecurityProtectionTypes: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityProtectionTypes: Security protection level.

attrSegmentInstanceIdRequired 

public readonly attrSegmentInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SegmentInstanceId: The ID of the consecutive EIPs.

attrServiceManagedRequired 

public readonly attrServiceManaged: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ServiceManaged: Indicates the resource created for the service account.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tag of the resource.