software.amazon.awscdk.services.lightsail

Class CfnStaticIp

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnStaticIp

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.670Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStaticIp(software.constructs.Construct scope, 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
String	getAttachedTo() The instance that the static IP is attached to.
String	getAttrIpAddress() The IP address of the static IP.
IResolvable	getAttrIsAttached() A Boolean value indicating whether the static IP is attached to an instance.
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 Map<String,Object>	getCfnProperties()
String	getStaticIpName() The name of the static IP.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttachedTo(String value) The instance that the static IP is attached to.
void	setStaticIpName(String value) The name of the static IP.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnStaticIp(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIpAddress

@Stability(value=Stable)
 @NotNull
public String getAttrIpAddress()

The IP address of the static IP.

getAttrIsAttached

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsAttached()

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

getAttrStaticIpArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getStaticIpName

@Stability(value=Stable)
 @NotNull
public String getStaticIpName()

The name of the static IP.

setStaticIpName

@Stability(value=Stable)
public void setStaticIpName(@NotNull
                                                     String value)

The name of the static IP.

getAttachedTo

@Stability(value=Stable)
 @Nullable
public String getAttachedTo()

The instance that the static IP is attached to.

setAttachedTo

@Stability(value=Stable)
public void setAttachedTo(@Nullable
                                                   String value)

The instance that the static IP is attached to.