SubnetGroup class
Provides an DocumentDB subnet group resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.docdb.SubnetGroup("default", {
name: "main",
subnetIds: [
frontend.id,
backend.id,
],
tags: {
Name: "My docdb subnet group",
},
});
import pulumi
import pulumi_aws as aws
default = aws.docdb.SubnetGroup("default",
name="main",
subnet_ids=[
frontend["id"],
backend["id"],
],
tags={
"Name": "My docdb subnet group",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.DocDB.SubnetGroup("default", new()
{
Name = "main",
SubnetIds = new[]
{
frontend.Id,
backend.Id,
},
Tags =
{
{ "Name", "My docdb subnet group" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/docdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := docdb.NewSubnetGroup(ctx, "default", &docdb.SubnetGroupArgs{
Name: pulumi.String("main"),
SubnetIds: pulumi.StringArray{
frontend.Id,
backend.Id,
},
Tags: pulumi.StringMap{
"Name": pulumi.String("My docdb subnet group"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_docdb_subnetgroup" "default" {
name = "main"
subnet_ids = [frontend.id, backend.id]
tags = {
"Name" = "My docdb subnet group"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.SubnetGroup;
import com.pulumi.aws.docdb.SubnetGroupArgs;
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 default_ = new SubnetGroup("default", SubnetGroupArgs.builder()
.name("main")
.subnetIds(
frontend.id(),
backend.id())
.tags(Map.of("Name", "My docdb subnet group"))
.build());
}
}
resources:
default:
type: aws:docdb:SubnetGroup
properties:
name: main
subnetIds:
- ${frontend.id}
- ${backend.id}
tags:
Name: My docdb subnet group
Import
Using pulumi import, import DocumentDB Subnet groups using the name. For example:
$ pulumi import aws:docdb/subnetGroup:SubnetGroup default production-subnet-group
Constructors
- SubnetGroup(String name, {SubnetGroupArgs? args, CustomResourceOptions? options})
-
Creates a new SubnetGroup.
nameThe Pulumi resource name.argsArguments used to configure this SubnetGroup. The set of arguments for SubnetGroup.optionsResource options controlling this resource's behavior. - SubnetGroup.reference(String urn)
- Creates a typed reference to an existing SubnetGroup resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the docDB subnet group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
name
↔ Output<
String> -
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
latefinal
-
namePrefix
↔ Output<
String> -
Creates a unique name beginning with the specified prefix. Conflicts with
name.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
-
subnetIds
↔ Output<
List< String> > -
A list of VPC subnet IDs.
latefinal
-
supportedNetworkTypes
↔ Output<
List< String> > -
The network type of the docDB subnet group (
IPV4orDUAL).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 -
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, {SubnetGroupState? state, CustomResourceOptions? options}) → SubnetGroup -
Gets an existing SubnetGroup resource's state with the given
nameandid.