DefaultSubnet class
Provides a resource to manage a default subnet in the current region.
This is an advanced resource and has special caveats to be aware of when using it. Please read this document in its entirety before using this resource.
The aws.ec2.DefaultSubnet resource behaves differently from normal resources in that if a default subnet exists in the specified Availability Zone, this provider does not create this resource, but instead "adopts" it into management.
If no default subnet exists, this provider creates a new default subnet.
By default, pulumi destroy does not delete the default subnet but does remove the resource from the state.
Set the forceDestroy argument to true to delete the default subnet.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const defaultAz1 = new aws.ec2.DefaultSubnet("default_az1", {
availabilityZone: "us-west-2a",
tags: {
Name: "Default subnet for us-west-2a",
},
});
import pulumi
import pulumi_aws as aws
default_az1 = aws.ec2.DefaultSubnet("default_az1",
availability_zone="us-west-2a",
tags={
"Name": "Default subnet for us-west-2a",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var defaultAz1 = new Aws.Ec2.DefaultSubnet("default_az1", new()
{
AvailabilityZone = "us-west-2a",
Tags =
{
{ "Name", "Default subnet for us-west-2a" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewDefaultSubnet(ctx, "default_az1", &ec2.DefaultSubnetArgs{
AvailabilityZone: pulumi.String("us-west-2a"),
Tags: pulumi.StringMap{
"Name": pulumi.String("Default subnet for us-west-2a"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_defaultsubnet" "default_az1" {
availability_zone = "us-west-2a"
tags = {
"Name" = "Default subnet for us-west-2a"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.DefaultSubnet;
import com.pulumi.aws.ec2.DefaultSubnetArgs;
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 defaultAz1 = new DefaultSubnet("defaultAz1", DefaultSubnetArgs.builder()
.availabilityZone("us-west-2a")
.tags(Map.of("Name", "Default subnet for us-west-2a"))
.build());
}
}
resources:
defaultAz1:
type: aws:ec2:DefaultSubnet
name: default_az1
properties:
availabilityZone: us-west-2a
tags:
Name: Default subnet for us-west-2a
Import
Using pulumi import, import subnets using the subnet id. For example:
$ pulumi import aws:ec2/defaultSubnet:DefaultSubnet public_subnet subnet-9d4a7b6c
Constructors
- DefaultSubnet(String name, {DefaultSubnetArgs? args, CustomResourceOptions? options})
-
Creates a new DefaultSubnet.
nameThe Pulumi resource name.argsArguments used to configure this DefaultSubnet. The set of arguments for DefaultSubnet.optionsResource options controlling this resource's behavior. - DefaultSubnet.reference(String urn)
- Creates a typed reference to an existing DefaultSubnet resource.
Properties
-
arn
↔ Output<
String> -
latefinal
-
assignIpv6AddressOnCreation
↔ Output<
bool?> -
latefinal
-
availabilityZone
↔ Output<
String> -
is required
latefinal
-
availabilityZoneId
↔ Output<
String> -
The AZ ID of the subnet
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
cidrBlock
↔ Output<
String> -
The IPv4 CIDR block assigned to the subnet
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customerOwnedIpv4Pool
↔ Output<
String?> -
latefinal
-
enableDns64
↔ Output<
bool?> -
latefinal
-
enableLniAtDeviceIndex
↔ Output<
int> -
latefinal
-
enableResourceNameDnsAaaaRecordOnLaunch
↔ Output<
bool?> -
latefinal
-
enableResourceNameDnsARecordOnLaunch
↔ Output<
bool?> -
latefinal
-
existingDefaultSubnet
↔ Output<
bool> -
latefinal
-
forceDestroy
↔ Output<
bool?> -
Whether destroying the resource deletes the default subnet. Default:
falselatefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
ipv6CidrBlock
↔ Output<
String> -
latefinal
-
ipv6CidrBlockAssociationId
↔ Output<
String> -
latefinal
-
ipv6Native
↔ Output<
bool?> -
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
-
mapCustomerOwnedIpOnLaunch
↔ Output<
bool?> -
latefinal
-
mapPublicIpOnLaunch
↔ Output<
bool?> -
latefinal
-
outpostArn
↔ Output<
String> -
latefinal
-
ownerId
↔ Output<
String> -
latefinal
-
privateDnsHostnameTypeOnLaunch
↔ Output<
String> -
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
-
latefinal
-
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String> -
The ID of the VPC the subnet is in
latefinal
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, {DefaultSubnetState? state, CustomResourceOptions? options}) → DefaultSubnet -
Gets an existing DefaultSubnet resource's state with the given
nameandid.