SecondarySubnet class
Provides an EC2 Secondary Subnet resource.
A secondary subnet is a subnet within a secondary network that provides high-performance networking capabilities for specialized workloads such as RDMA (Remote Direct Memory Access) applications.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.SecondaryNetwork("example", {
ipv4CidrBlock: "10.0.0.0/16",
networkType: "rdma",
tags: {
Name: "example-secondary-network",
},
});
const exampleSecondarySubnet = new aws.ec2.SecondarySubnet("example", {
secondaryNetworkId: example.id,
ipv4CidrBlock: "10.0.1.0/24",
availabilityZone: "us-west-2a",
tags: {
Name: "example-secondary-subnet",
},
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.SecondaryNetwork("example",
ipv4_cidr_block="10.0.0.0/16",
network_type="rdma",
tags={
"Name": "example-secondary-network",
})
example_secondary_subnet = aws.ec2.SecondarySubnet("example",
secondary_network_id=example.id,
ipv4_cidr_block="10.0.1.0/24",
availability_zone="us-west-2a",
tags={
"Name": "example-secondary-subnet",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2.SecondaryNetwork("example", new()
{
Ipv4CidrBlock = "10.0.0.0/16",
NetworkType = "rdma",
Tags =
{
{ "Name", "example-secondary-network" },
},
});
var exampleSecondarySubnet = new Aws.Ec2.SecondarySubnet("example", new()
{
SecondaryNetworkId = example.Id,
Ipv4CidrBlock = "10.0.1.0/24",
AvailabilityZone = "us-west-2a",
Tags =
{
{ "Name", "example-secondary-subnet" },
},
});
});
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 {
example, err := ec2.NewSecondaryNetwork(ctx, "example", &ec2.SecondaryNetworkArgs{
Ipv4CidrBlock: pulumi.String("10.0.0.0/16"),
NetworkType: pulumi.String("rdma"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-secondary-network"),
},
})
if err != nil {
return err
}
_, err = ec2.NewSecondarySubnet(ctx, "example", &ec2.SecondarySubnetArgs{
SecondaryNetworkId: example.ID().ToIDOutput().ToStringOutput(),
Ipv4CidrBlock: pulumi.String("10.0.1.0/24"),
AvailabilityZone: pulumi.String("us-west-2a"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-secondary-subnet"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_secondarynetwork" "example" {
ipv4_cidr_block = "10.0.0.0/16"
network_type = "rdma"
tags = {
"Name" = "example-secondary-network"
}
}
resource "aws_ec2_secondarysubnet" "example" {
secondary_network_id = aws_ec2_secondarynetwork.example.id
ipv4_cidr_block = "10.0.1.0/24"
availability_zone = "us-west-2a"
tags = {
"Name" = "example-secondary-subnet"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.SecondaryNetwork;
import com.pulumi.aws.ec2.SecondaryNetworkArgs;
import com.pulumi.aws.ec2.SecondarySubnet;
import com.pulumi.aws.ec2.SecondarySubnetArgs;
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 SecondaryNetwork("example", SecondaryNetworkArgs.builder()
.ipv4CidrBlock("10.0.0.0/16")
.networkType("rdma")
.tags(Map.of("Name", "example-secondary-network"))
.build());
var exampleSecondarySubnet = new SecondarySubnet("exampleSecondarySubnet", SecondarySubnetArgs.builder()
.secondaryNetworkId(example.id())
.ipv4CidrBlock("10.0.1.0/24")
.availabilityZone("us-west-2a")
.tags(Map.of("Name", "example-secondary-subnet"))
.build());
}
}
resources:
example:
type: aws:ec2:SecondaryNetwork
properties:
ipv4CidrBlock: 10.0.0.0/16
networkType: rdma
tags:
Name: example-secondary-network
exampleSecondarySubnet:
type: aws:ec2:SecondarySubnet
name: example
properties:
secondaryNetworkId: ${example.id}
ipv4CidrBlock: 10.0.1.0/24
availabilityZone: us-west-2a
tags:
Name: example-secondary-subnet
Using Availability Zone ID
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.ec2.SecondaryNetwork("example", {
ipv4CidrBlock: "10.0.0.0/16",
networkType: "rdma",
tags: {
Name: "example-secondary-network",
},
});
const exampleSecondarySubnet = new aws.ec2.SecondarySubnet("example", {
secondaryNetworkId: example.id,
ipv4CidrBlock: "10.0.1.0/24",
availabilityZoneId: available.then(available => available.zoneIds?.[0]),
tags: {
Name: "example-secondary-subnet",
},
});
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.ec2.SecondaryNetwork("example",
ipv4_cidr_block="10.0.0.0/16",
network_type="rdma",
tags={
"Name": "example-secondary-network",
})
example_secondary_subnet = aws.ec2.SecondarySubnet("example",
secondary_network_id=example.id,
ipv4_cidr_block="10.0.1.0/24",
availability_zone_id=available.zone_ids[0],
tags={
"Name": "example-secondary-subnet",
})
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.Ec2.SecondaryNetwork("example", new()
{
Ipv4CidrBlock = "10.0.0.0/16",
NetworkType = "rdma",
Tags =
{
{ "Name", "example-secondary-network" },
},
});
var exampleSecondarySubnet = new Aws.Ec2.SecondarySubnet("example", new()
{
SecondaryNetworkId = example.Id,
Ipv4CidrBlock = "10.0.1.0/24",
AvailabilityZoneId = available.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.ZoneIds[0]),
Tags =
{
{ "Name", "example-secondary-subnet" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"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 {
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 := ec2.NewSecondaryNetwork(ctx, "example", &ec2.SecondaryNetworkArgs{
Ipv4CidrBlock: pulumi.String("10.0.0.0/16"),
NetworkType: pulumi.String("rdma"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-secondary-network"),
},
})
if err != nil {
return err
}
_, err = ec2.NewSecondarySubnet(ctx, "example", &ec2.SecondarySubnetArgs{
SecondaryNetworkId: example.ID().ToIDOutput().ToStringOutput(),
Ipv4CidrBlock: pulumi.String("10.0.1.0/24"),
AvailabilityZoneId: pulumi.String(available.ZoneIds[0]),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-secondary-subnet"),
},
})
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_ec2_secondarynetwork" "example" {
ipv4_cidr_block = "10.0.0.0/16"
network_type = "rdma"
tags = {
"Name" = "example-secondary-network"
}
}
resource "aws_ec2_secondarysubnet" "example" {
secondary_network_id = aws_ec2_secondarynetwork.example.id
ipv4_cidr_block = "10.0.1.0/24"
availability_zone_id = data.aws_getavailabilityzones.available.zone_ids[0]
tags = {
"Name" = "example-secondary-subnet"
}
}
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.ec2.SecondaryNetwork;
import com.pulumi.aws.ec2.SecondaryNetworkArgs;
import com.pulumi.aws.ec2.SecondarySubnet;
import com.pulumi.aws.ec2.SecondarySubnetArgs;
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 SecondaryNetwork("example", SecondaryNetworkArgs.builder()
.ipv4CidrBlock("10.0.0.0/16")
.networkType("rdma")
.tags(Map.of("Name", "example-secondary-network"))
.build());
var exampleSecondarySubnet = new SecondarySubnet("exampleSecondarySubnet", SecondarySubnetArgs.builder()
.secondaryNetworkId(example.id())
.ipv4CidrBlock("10.0.1.0/24")
.availabilityZoneId(available.zoneIds()[0])
.tags(Map.of("Name", "example-secondary-subnet"))
.build());
}
}
resources:
example:
type: aws:ec2:SecondaryNetwork
properties:
ipv4CidrBlock: 10.0.0.0/16
networkType: rdma
tags:
Name: example-secondary-network
exampleSecondarySubnet:
type: aws:ec2:SecondarySubnet
name: example
properties:
secondaryNetworkId: ${example.id}
ipv4CidrBlock: 10.0.1.0/24
availabilityZoneId: ${available.zoneIds[0]}
tags:
Name: example-secondary-subnet
variables:
available:
fn::invoke:
function: aws:getAvailabilityZones
arguments:
filters:
- name: opt-in-status
values:
- opt-in-not-required
state: available
Import
Identity Schema
Required
id- (String) ID of the secondary subnet.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import EC2 Secondary Subnets using the secondary subnet ID. For example:
$ pulumi import aws:ec2/secondarySubnet:SecondarySubnet example ss-0123456789abcdef0
Constructors
- SecondarySubnet(String name, {SecondarySubnetArgs? args, CustomResourceOptions? options})
-
Creates a new SecondarySubnet.
nameThe Pulumi resource name.argsArguments used to configure this SecondarySubnet. The set of arguments for SecondarySubnet.optionsResource options controlling this resource's behavior. - SecondarySubnet.reference(String urn)
- Creates a typed reference to an existing SecondarySubnet resource.
Properties
-
arn
↔ Output<
String> -
ARN of the secondary subnet.
latefinal
-
availabilityZone
↔ Output<
String> -
Availability Zone for the secondary subnet. Cannot be specified with
availabilityZoneId.latefinal -
availabilityZoneId
↔ Output<
String> -
ID of the Availability Zone for the secondary subnet. This option is preferred over
availabilityZoneas it provides a consistent identifier across AWS accounts. Cannot be specified withavailabilityZone.latefinal -
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
-
ipv4CidrBlock
↔ Output<
String> -
IPv4 CIDR block for the secondary subnet. The CIDR block size must be between
/12and/28.latefinal -
ipv4CidrBlockAssociations
↔ Output<
List< SecondarySubnetIpv4CidrBlockAssociation> > -
A list of IPv4 CIDR block associations for the secondary network.
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
-
ownerId
↔ Output<
String> -
ID of the AWS account that owns the secondary subnet.
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
-
secondaryNetworkId
↔ Output<
String> -
ID of the secondary network in which to create the secondary subnet.
latefinal
-
secondaryNetworkType
↔ Output<
String> -
Type of the secondary network (e.g.,
rdma).latefinal -
secondarySubnetId
↔ Output<
String> -
ID of the secondary subnet.
latefinal
-
state
↔ Output<
String> -
State of the IPv4 CIDR block association.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
SecondarySubnetTimeouts?> -
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, {SecondarySubnetState? state, CustomResourceOptions? options}) → SecondarySubnet -
Gets an existing SecondarySubnet resource's state with the given
nameandid.