StaticIpAttachment class
Manages a static IP address attachment - relationship between a Lightsail static IP and Lightsail instance.
Use this resource to attach a static IP address to a Lightsail instance to provide a consistent public IP address that persists across instance restarts.
> Note: Lightsail is currently only supported in a limited number of AWS Regions, please see "Regions and Availability Zones in Amazon Lightsail" for more details.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lightsail.StaticIp("example", {name: "example"});
const exampleInstance = new aws.lightsail.Instance("example", {
name: "example",
availabilityZone: "us-east-1a",
blueprintId: "ubuntu_20_04",
bundleId: "nano_2_0",
});
const exampleStaticIpAttachment = new aws.lightsail.StaticIpAttachment("example", {
staticIpName: example.name,
instanceName: exampleInstance.name,
});
import pulumi
import pulumi_aws as aws
example = aws.lightsail.StaticIp("example", name="example")
example_instance = aws.lightsail.Instance("example",
name="example",
availability_zone="us-east-1a",
blueprint_id="ubuntu_20_04",
bundle_id="nano_2_0")
example_static_ip_attachment = aws.lightsail.StaticIpAttachment("example",
static_ip_name=example.name,
instance_name=example_instance.name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LightSail.StaticIp("example", new()
{
Name = "example",
});
var exampleInstance = new Aws.LightSail.Instance("example", new()
{
Name = "example",
AvailabilityZone = "us-east-1a",
BlueprintId = "ubuntu_20_04",
BundleId = "nano_2_0",
});
var exampleStaticIpAttachment = new Aws.LightSail.StaticIpAttachment("example", new()
{
StaticIpName = example.Name,
InstanceName = exampleInstance.Name,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := lightsail.NewStaticIp(ctx, "example", &lightsail.StaticIpArgs{
Name: pulumi.String("example"),
})
if err != nil {
return err
}
exampleInstance, err := lightsail.NewInstance(ctx, "example", &lightsail.InstanceArgs{
Name: pulumi.String("example"),
AvailabilityZone: pulumi.String("us-east-1a"),
BlueprintId: pulumi.String("ubuntu_20_04"),
BundleId: pulumi.String("nano_2_0"),
})
if err != nil {
return err
}
_, err = lightsail.NewStaticIpAttachment(ctx, "example", &lightsail.StaticIpAttachmentArgs{
StaticIpName: example.Name,
InstanceName: exampleInstance.Name,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lightsail_staticip" "example" {
name = "example"
}
resource "aws_lightsail_instance" "example" {
name = "example"
availability_zone = "us-east-1a"
blueprint_id = "ubuntu_20_04"
bundle_id = "nano_2_0"
}
resource "aws_lightsail_staticipattachment" "example" {
static_ip_name = aws_lightsail_staticip.example.name
instance_name = aws_lightsail_instance.example.name
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.StaticIp;
import com.pulumi.aws.lightsail.StaticIpArgs;
import com.pulumi.aws.lightsail.Instance;
import com.pulumi.aws.lightsail.InstanceArgs;
import com.pulumi.aws.lightsail.StaticIpAttachment;
import com.pulumi.aws.lightsail.StaticIpAttachmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new StaticIp("example", StaticIpArgs.builder()
.name("example")
.build());
var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
.name("example")
.availabilityZone("us-east-1a")
.blueprintId("ubuntu_20_04")
.bundleId("nano_2_0")
.build());
var exampleStaticIpAttachment = new StaticIpAttachment("exampleStaticIpAttachment", StaticIpAttachmentArgs.builder()
.staticIpName(example.name())
.instanceName(exampleInstance.name())
.build());
}
}
resources:
example:
type: aws:lightsail:StaticIp
properties:
name: example
exampleInstance:
type: aws:lightsail:Instance
name: example
properties:
name: example
availabilityZone: us-east-1a
blueprintId: ubuntu_20_04
bundleId: nano_2_0
exampleStaticIpAttachment:
type: aws:lightsail:StaticIpAttachment
name: example
properties:
staticIpName: ${example.name}
instanceName: ${exampleInstance.name}
Import
Using pulumi import, import aws.lightsail.StaticIpAttachment using the static IP name. For example:
$ pulumi import aws:lightsail/staticIpAttachment:StaticIpAttachment example example-static-ip
Constructors
- StaticIpAttachment(String name, {StaticIpAttachmentArgs? args, CustomResourceOptions? options})
-
Creates a new StaticIpAttachment.
nameThe Pulumi resource name.argsArguments used to configure this StaticIpAttachment. The set of arguments for StaticIpAttachment.optionsResource options controlling this resource's behavior. - StaticIpAttachment.reference(String urn)
- Creates a typed reference to an existing StaticIpAttachment resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceName
↔ Output<
String> -
Name of the Lightsail instance to attach the IP to.
latefinal
-
ipAddress
↔ Output<
String> -
Allocated static IP address.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
staticIpName
↔ Output<
String> -
Name of the allocated static IP.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {StaticIpAttachmentState? state, CustomResourceOptions? options}) → StaticIpAttachment -
Gets an existing StaticIpAttachment resource's state with the given
nameandid.