Address
- Implements: com.aliyun.ros.cdk.vpc.datasource.IAddress
This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Address.
Initializers
import com.aliyun.ros.cdk.vpc.datasource.Address;
Address.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.allocationId(java.lang.String)
.allocationId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
allocationId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property allocationId: The ID of the EIP instance. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
allocationIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property allocationId: The ID of the EIP instance.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vpc.datasource.Address;
Address.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrAddressName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AddressName: The name of the EIP. |
attrAllocationId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AllocationId: The ID of the EIP instance. |
attrBandwidth | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Bandwidth: The peak bandwidth of the EIP. |
attrBandwidthPackageBandwidth | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP. |
attrBandwidthPackageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BandwidthPackageId: The ID of the added shared bandwidth. |
attrBandwidthPackageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BandwidthPackageType: The type of bandwidth. |
attrBusinessStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BusinessStatus: The business status of the EIP instance. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the EIP was created. |
attrDeletionProtection | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DeletionProtection: Whether the delete protection function is turned on. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the EIP instance. |
attrEipBandwidth | java.lang.String OR com.aliyun.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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '. |
attrHasReservationData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HasReservationData: Whether there is renewal data. |
attrHdMonitorStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the current bound instance. |
attrInstanceRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceRegionId: The region ID of the currently bound resource. |
attrInstanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceType: The type of the current bound instance. |
attrIpAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpAddress: The IP address of the EIP. |
attrIsp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Isp: Service providers. |
attrNetmode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Netmode: Network type. |
attrOperationLocks | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OperationLocks: Lock details. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The billing method of the EIP. |
attrPublicIpAddressPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs. |
attrReservationActiveTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'. |
attrReservationBandwidth | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ReservationBandwidth: Renewal bandwidth, in Mbps. |
attrReservationInternetChargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ReservationInternetChargeType: Renewal Payment type. |
attrReservationOrderType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ReservationOrderType: Renewal order type. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrSecondLimited | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecondLimited: Whether a secondary speed limit is configured. |
attrSecurityProtectionTypes | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecurityProtectionTypes: Security protection level. |
attrSegmentInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SegmentInstanceId: The ID of the consecutive EIPs. |
attrServiceManaged | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServiceManaged: Indicates the resource created for the service account. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tag of the resource. |
props | AddressProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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 java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrAddressNameRequired
public java.lang.Object getAttrAddressName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AddressName: The name of the EIP.
attrAllocationIdRequired
public java.lang.Object getAttrAllocationId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AllocationId: The ID of the EIP instance.
attrBandwidthRequired
public java.lang.Object getAttrBandwidth();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Bandwidth: The peak bandwidth of the EIP.
Unit: Mbps.
attrBandwidthPackageBandwidthRequired
public java.lang.Object getAttrBandwidthPackageBandwidth();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP.
The unit is Mbps.
attrBandwidthPackageIdRequired
public java.lang.Object getAttrBandwidthPackageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BandwidthPackageId: The ID of the added shared bandwidth.
attrBandwidthPackageTypeRequired
public java.lang.Object getAttrBandwidthPackageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BandwidthPackageType: The type of bandwidth.
Only CommonBandwidthPackage (shared bandwidth) is supported.
attrBusinessStatusRequired
public java.lang.Object getAttrBusinessStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BusinessStatus: The business status of the EIP instance.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the EIP was created.
attrDeletionProtectionRequired
public java.lang.Object getAttrDeletionProtection();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DeletionProtection: Whether the delete protection function is turned on.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the EIP instance.
attrEipBandwidthRequired
public java.lang.Object getAttrEipBandwidth();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrExpiredTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.
attrHasReservationDataRequired
public java.lang.Object getAttrHasReservationData();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HasReservationData: Whether there is renewal data.
attrHdMonitorStatusRequired
public java.lang.Object getAttrHdMonitorStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the current bound instance.
attrInstanceRegionIdRequired
public java.lang.Object getAttrInstanceRegionId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceRegionId: The region ID of the currently bound resource.
attrInstanceTypeRequired
public java.lang.Object getAttrInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceType: The type of the current bound instance.
attrIpAddressRequired
public java.lang.Object getAttrIpAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpAddress: The IP address of the EIP.
attrIspRequired
public java.lang.Object getAttrIsp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Isp: Service providers.
attrNetmodeRequired
public java.lang.Object getAttrNetmode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Netmode: Network type.
attrOperationLocksRequired
public java.lang.Object getAttrOperationLocks();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OperationLocks: Lock details.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The billing method of the EIP.
attrPublicIpAddressPoolIdRequired
public java.lang.Object getAttrPublicIpAddressPoolId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs.
attrReservationActiveTimeRequired
public java.lang.Object getAttrReservationActiveTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.
attrReservationBandwidthRequired
public java.lang.Object getAttrReservationBandwidth();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ReservationBandwidth: Renewal bandwidth, in Mbps.
attrReservationInternetChargeTypeRequired
public java.lang.Object getAttrReservationInternetChargeType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ReservationInternetChargeType: Renewal Payment type.
attrReservationOrderTypeRequired
public java.lang.Object getAttrReservationOrderType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ReservationOrderType: Renewal order type.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSecondLimitedRequired
public java.lang.Object getAttrSecondLimited();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecondLimited: Whether a secondary speed limit is configured.
attrSecurityProtectionTypesRequired
public java.lang.Object getAttrSecurityProtectionTypes();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityProtectionTypes: Security protection level.
attrSegmentInstanceIdRequired
public java.lang.Object getAttrSegmentInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SegmentInstanceId: The ID of the consecutive EIPs.
attrServiceManagedRequired
public java.lang.Object getAttrServiceManaged();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceManaged: Indicates the resource created for the service account.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tag of the resource.
propsRequired
public AddressProps getProps();
- Type: AddressProps