Class SubnetGroup

Provides an DocumentDB subnet group resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.DocDB.SubnetGroup("default", new Aws.DocDB.SubnetGroupArgs
    {
        SubnetIds = 
        {
            aws_subnet.Frontend.Id,
            aws_subnet.Backend.Id,
        },
        Tags = 
        {
            { "Name", "My docdb subnet group" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SubnetGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.DocDB

Assembly: Pulumi.Aws.dll

Syntax

public class SubnetGroup : CustomResource

Constructors

SubnetGroup(String, SubnetGroupArgs, CustomResourceOptions)

Create a SubnetGroup resource with the given unique name, arguments, and options.

Declaration

public SubnetGroup(string name, SubnetGroupArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SubnetGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the docDB subnet group.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the docDB subnet group. Defaults to "Managed by Pulumi".

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name.

Declaration

public Output<string> NamePrefix { get; }

Property Value

Type	Description
Output<System.String>

SubnetIds

A list of VPC subnet IDs.

Declaration

public Output<ImmutableArray<string>> SubnetIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, SubnetGroupState, CustomResourceOptions)

Get an existing SubnetGroup resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static SubnetGroup Get(string name, Input<string> id, SubnetGroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SubnetGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SubnetGroup