software.amazon.awscdk.services.lightsail

Class CfnStaticIp

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lightsail.CfnStaticIp

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.421Z")
public class CfnStaticIp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::StaticIp`.

The AWS::Lightsail::StaticIp resource specifies a static IP that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 CfnStaticIp cfnStaticIp = CfnStaticIp.Builder.create(this, "MyCfnStaticIp")
         .staticIpName("staticIpName")
         // the properties below are optional
         .attachedTo("attachedTo")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStaticIp.Builder A fluent builder for CfnStaticIp.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStaticIp(Construct scope, java.lang.String id, CfnStaticIpProps props) Create a new `AWS::Lightsail::StaticIp`.
protected	CfnStaticIp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStaticIp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttachedTo() The instance that the static IP is attached to.
java.lang.String	getAttrIpAddress() The IP address of the static IP.
IResolvable	getAttrIsAttached() A Boolean value indicating whether the static IP is attached to an instance.
java.lang.String	getAttrStaticIpArn() The Amazon Resource Name (ARN) of the static IP (for example, `arn:aws:lightsail:us-east-2:123456789101:StaticIp/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getStaticIpName() The name of the static IP.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAttachedTo(java.lang.String value) The instance that the static IP is attached to.
void	setStaticIpName(java.lang.String value) The name of the static IP.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStaticIp

protected CfnStaticIp(software.amazon.jsii.JsiiObjectRef objRef)

CfnStaticIp

protected CfnStaticIp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStaticIp

public CfnStaticIp(Construct scope,
                   java.lang.String id,
                   CfnStaticIpProps props)

Create a new `AWS::Lightsail::StaticIp`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIpAddress

public java.lang.String getAttrIpAddress()

The IP address of the static IP.

getAttrIsAttached

public IResolvable getAttrIsAttached()

A Boolean value indicating whether the static IP is attached to an instance.

getAttrStaticIpArn

public java.lang.String getAttrStaticIpArn()

The Amazon Resource Name (ARN) of the static IP (for example, `arn:aws:lightsail:us-east-2:123456789101:StaticIp/244ad76f-8aad-4741-809f-12345EXAMPLE` ).

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getStaticIpName

public java.lang.String getStaticIpName()

The name of the static IP.

setStaticIpName

public void setStaticIpName(java.lang.String value)

The name of the static IP.

getAttachedTo

public java.lang.String getAttachedTo()

The instance that the static IP is attached to.

setAttachedTo

public void setAttachedTo(java.lang.String value)

The instance that the static IP is attached to.