Docs Packages
  1. Packages
  2. StrongDM
  3. API Docs
  4. PeeringGroup
StrongDM v1.12.0 published on Sunday, Apr 28, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-sdm

sdm.PeeringGroup

Explore with Pulumi AI

sdm logo
StrongDM v1.12.0 published on Sunday, Apr 28, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-sdm

    PeeringGroups are the building blocks used for explicit network topology making. They may be linked to other peering groups. Sets of PeeringGroupResource and PeeringGroupNode can be attached to a peering group. This resource can be imported using the import command.

    Create PeeringGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PeeringGroup(name: string, args?: PeeringGroupArgs, opts?: CustomResourceOptions);
    @overload
def PeeringGroup(resource_name: str,
                 args: Optional[PeeringGroupArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def PeeringGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 name: Optional[str] = None)
    func NewPeeringGroup(ctx *Context, name string, args *PeeringGroupArgs, opts ...ResourceOption) (*PeeringGroup, error)
    public PeeringGroup(string name, PeeringGroupArgs? args = null, CustomResourceOptions? opts = null)
    public PeeringGroup(String name, PeeringGroupArgs args)
public PeeringGroup(String name, PeeringGroupArgs args, CustomResourceOptions options)

    type: sdm:PeeringGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PeeringGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PeeringGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PeeringGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeeringGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeeringGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var peeringGroupResource = new Sdm.PeeringGroup("peeringGroupResource", new()
{
    Name = "string",
});

    example, err := sdm.NewPeeringGroup(ctx, "peeringGroupResource", &sdm.PeeringGroupArgs{
	Name: pulumi.String("string"),
})

    var peeringGroupResource = new PeeringGroup("peeringGroupResource", PeeringGroupArgs.builder()        
    .name("string")
    .build());

    peering_group_resource = sdm.PeeringGroup("peeringGroupResource", name="string")

    const peeringGroupResource = new sdm.PeeringGroup("peeringGroupResource", {name: "string"});

    type: sdm:PeeringGroup
properties:
    name: string

    PeeringGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PeeringGroup resource accepts the following input properties:

    Name string
    Unique human-readable name of the PeeringGroup.
    Name string
    Unique human-readable name of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.
    name string
    Unique human-readable name of the PeeringGroup.
    name str
    Unique human-readable name of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PeeringGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PeeringGroup Resource

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

    public static get(name: string, id: Input<ID>, state?: PeeringGroupState, opts?: CustomResourceOptions): PeeringGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None) -> PeeringGroup
    func GetPeeringGroup(ctx *Context, name string, id IDInput, state *PeeringGroupState, opts ...ResourceOption) (*PeeringGroup, error)
    public static PeeringGroup Get(string name, Input<string> id, PeeringGroupState? state, CustomResourceOptions? opts = null)
    public static PeeringGroup get(String name, Output<String> id, PeeringGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Name string
    Unique human-readable name of the PeeringGroup.
    Name string
    Unique human-readable name of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.
    name string
    Unique human-readable name of the PeeringGroup.
    name str
    Unique human-readable name of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.

    Import

    A PeeringGroup can be imported using the id, e.g.,

    $ pulumi import sdm:index/peeringGroup:PeeringGroup example g-12345678

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    sdm pierskarsenbarg/pulumi-sdm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdm Terraform Provider.
    sdm logo
    StrongDM v1.12.0 published on Sunday, Apr 28, 2024 by Piers Karsenbarg
    pierskarsenbarg/pulumi-sdm