InstancePublicPorts class
Manages public ports for a Lightsail instance. Use this resource to open ports for a specific Amazon Lightsail instance and specify the IP addresses allowed to connect to the instance through the ports and the protocol.
> See What is Amazon Lightsail? for more information.
> 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 available = aws.getAvailabilityZones({
filters: [{
name: "opt-in-status",
values: ["opt-in-not-required"],
}],
state: "available",
});
const example = new aws.lightsail.Instance("example", {
name: "example-instance",
availabilityZone: available.then(available => available.names?.[0]),
blueprintId: "amazon_linux_2",
bundleId: "nano_3_0",
});
const exampleInstancePublicPorts = new aws.lightsail.InstancePublicPorts("example", {
portInfos: [
{
protocol: "tcp",
fromPort: 80,
toPort: 80,
},
{
protocol: "tcp",
fromPort: 443,
toPort: 443,
cidrs: ["192.168.1.0/24"],
},
],
instanceName: example.name,
});
import pulumi
import pulumi_aws as aws
available = aws.get_availability_zones(filters=[{
"name": "opt-in-status",
"values": ["opt-in-not-required"],
}],
state="available")
example = aws.lightsail.Instance("example",
name="example-instance",
availability_zone=available.names[0],
blueprint_id="amazon_linux_2",
bundle_id="nano_3_0")
example_instance_public_ports = aws.lightsail.InstancePublicPorts("example",
port_infos=[
{
"protocol": "tcp",
"from_port": 80,
"to_port": 80,
},
{
"protocol": "tcp",
"from_port": 443,
"to_port": 443,
"cidrs": ["192.168.1.0/24"],
},
],
instance_name=example.name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var available = Aws.GetAvailabilityZones.Invoke(new()
{
Filters = new[]
{
new Aws.Inputs.GetAvailabilityZonesFilterInputArgs
{
Name = "opt-in-status",
Values = new[]
{
"opt-in-not-required",
},
},
},
State = "available",
});
var example = new Aws.LightSail.Instance("example", new()
{
Name = "example-instance",
AvailabilityZone = available.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[0]),
BlueprintId = "amazon_linux_2",
BundleId = "nano_3_0",
});
var exampleInstancePublicPorts = new Aws.LightSail.InstancePublicPorts("example", new()
{
PortInfos = new[]
{
new Aws.LightSail.Inputs.InstancePublicPortsPortInfoArgs
{
Protocol = "tcp",
FromPort = 80,
ToPort = 80,
},
new Aws.LightSail.Inputs.InstancePublicPortsPortInfoArgs
{
Protocol = "tcp",
FromPort = 443,
ToPort = 443,
Cidrs = new[]
{
"192.168.1.0/24",
},
},
},
InstanceName = example.Name,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"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 {
available, err := aws.GetAvailabilityZones(ctx, &aws.GetAvailabilityZonesArgs{
Filters: []aws.GetAvailabilityZonesFilter{
{
Name: "opt-in-status",
Values: []string{
"opt-in-not-required",
},
},
},
State: pulumi.StringRef("available"),
}, nil)
if err != nil {
return err
}
example, err := lightsail.NewInstance(ctx, "example", &lightsail.InstanceArgs{
Name: pulumi.String("example-instance"),
AvailabilityZone: pulumi.String(available.Names[0]),
BlueprintId: pulumi.String("amazon_linux_2"),
BundleId: pulumi.String("nano_3_0"),
})
if err != nil {
return err
}
_, err = lightsail.NewInstancePublicPorts(ctx, "example", &lightsail.InstancePublicPortsArgs{
PortInfos: lightsail.InstancePublicPortsPortInfoArray{
&lightsail.InstancePublicPortsPortInfoArgs{
Protocol: pulumi.String("tcp"),
FromPort: pulumi.Int(80),
ToPort: pulumi.Int(80),
},
&lightsail.InstancePublicPortsPortInfoArgs{
Protocol: pulumi.String("tcp"),
FromPort: pulumi.Int(443),
ToPort: pulumi.Int(443),
Cidrs: pulumi.StringArray{
pulumi.String("192.168.1.0/24"),
},
},
},
InstanceName: example.Name,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getavailabilityzones" "available" {
filters {
name = "opt-in-status"
values = ["opt-in-not-required"]
}
state = "available"
}
resource "aws_lightsail_instance" "example" {
name = "example-instance"
availability_zone = data.aws_getavailabilityzones.available.names[0]
blueprint_id = "amazon_linux_2"
bundle_id = "nano_3_0"
}
resource "aws_lightsail_instancepublicports" "example" {
port_infos {
protocol = "tcp"
from_port = 80
to_port = 80
}
port_infos {
protocol = "tcp"
from_port = 443
to_port = 443
cidrs = ["192.168.1.0/24"]
}
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.AwsFunctions;
import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
import com.pulumi.aws.inputs.GetAvailabilityZonesFilterArgs;
import com.pulumi.aws.lightsail.Instance;
import com.pulumi.aws.lightsail.InstanceArgs;
import com.pulumi.aws.lightsail.InstancePublicPorts;
import com.pulumi.aws.lightsail.InstancePublicPortsArgs;
import com.pulumi.aws.lightsail.inputs.InstancePublicPortsPortInfoArgs;
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) {
final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
.filters(GetAvailabilityZonesFilterArgs.builder()
.name("opt-in-status")
.values("opt-in-not-required")
.build())
.state("available")
.build());
var example = new Instance("example", InstanceArgs.builder()
.name("example-instance")
.availabilityZone(available.names()[0])
.blueprintId("amazon_linux_2")
.bundleId("nano_3_0")
.build());
var exampleInstancePublicPorts = new InstancePublicPorts("exampleInstancePublicPorts", InstancePublicPortsArgs.builder()
.portInfos(
InstancePublicPortsPortInfoArgs.builder()
.protocol("tcp")
.fromPort(80)
.toPort(80)
.build(),
InstancePublicPortsPortInfoArgs.builder()
.protocol("tcp")
.fromPort(443)
.toPort(443)
.cidrs("192.168.1.0/24")
.build())
.instanceName(example.name())
.build());
}
}
resources:
example:
type: aws:lightsail:Instance
properties:
name: example-instance
availabilityZone: ${available.names[0]}
blueprintId: amazon_linux_2
bundleId: nano_3_0
exampleInstancePublicPorts:
type: aws:lightsail:InstancePublicPorts
name: example
properties:
portInfos:
- protocol: tcp
fromPort: 80
toPort: 80
- protocol: tcp
fromPort: 443
toPort: 443
cidrs:
- 192.168.1.0/24
instanceName: ${example.name}
variables:
available:
fn::invoke:
function: aws:getAvailabilityZones
arguments:
filters:
- name: opt-in-status
values:
- opt-in-not-required
state: available
Constructors
- InstancePublicPorts(String name, {InstancePublicPortsArgs? args, CustomResourceOptions? options})
-
Creates a new InstancePublicPorts.
nameThe Pulumi resource name.argsArguments used to configure this InstancePublicPorts. The set of arguments for InstancePublicPorts.optionsResource options controlling this resource's behavior. - InstancePublicPorts.reference(String urn)
- Creates a typed reference to an existing InstancePublicPorts 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 instance for which to open ports.
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
-
portInfos
↔ Output<
List< InstancePublicPortsPortInfo> > -
Descriptor of the ports to open for the specified instance. AWS closes all currently open ports that are not included in this argument. See
portInfoBlock for details.latefinal -
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
-
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, {InstancePublicPortsState? state, CustomResourceOptions? options}) → InstancePublicPorts -
Gets an existing InstancePublicPorts resource's state with the given
nameandid.