1. Packages
  2. StrongDM
  3. API Docs
  4. getPeeringGroup
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

sdm.getPeeringGroup

Explore with Pulumi AI

sdm logo
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    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.

    Using getPeeringGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPeeringGroup(args: GetPeeringGroupArgs, opts?: InvokeOptions): Promise<GetPeeringGroupResult>
    function getPeeringGroupOutput(args: GetPeeringGroupOutputArgs, opts?: InvokeOptions): Output<GetPeeringGroupResult>
    def get_peering_group(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPeeringGroupResult
    def get_peering_group_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPeeringGroupResult]
    func LookupPeeringGroup(ctx *Context, args *LookupPeeringGroupArgs, opts ...InvokeOption) (*LookupPeeringGroupResult, error)
    func LookupPeeringGroupOutput(ctx *Context, args *LookupPeeringGroupOutputArgs, opts ...InvokeOption) LookupPeeringGroupResultOutput

    > Note: This function is named LookupPeeringGroup in the Go SDK.

    public static class GetPeeringGroup 
    {
        public static Task<GetPeeringGroupResult> InvokeAsync(GetPeeringGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetPeeringGroupResult> Invoke(GetPeeringGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPeeringGroupResult> getPeeringGroup(GetPeeringGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: sdm:index/getPeeringGroup:getPeeringGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getPeeringGroup Result

    The following output properties are available:

    Ids List<string>
    a list of strings of ids of data sources that match the given arguments.
    PeeringGroups List<PiersKarsenbarg.Sdm.Outputs.GetPeeringGroupPeeringGroup>
    A list where each element has the following attributes:
    Id string
    Unique identifier of the PeeringGroup.
    Name string
    Unique human-readable name of the PeeringGroup.
    Ids []string
    a list of strings of ids of data sources that match the given arguments.
    PeeringGroups []GetPeeringGroupPeeringGroup
    A list where each element has the following attributes:
    Id string
    Unique identifier of the PeeringGroup.
    Name string
    Unique human-readable name of the PeeringGroup.
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    peeringGroups List<GetPeeringGroupPeeringGroup>
    A list where each element has the following attributes:
    id String
    Unique identifier of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.
    ids string[]
    a list of strings of ids of data sources that match the given arguments.
    peeringGroups GetPeeringGroupPeeringGroup[]
    A list where each element has the following attributes:
    id string
    Unique identifier of the PeeringGroup.
    name string
    Unique human-readable name of the PeeringGroup.
    ids Sequence[str]
    a list of strings of ids of data sources that match the given arguments.
    peering_groups Sequence[GetPeeringGroupPeeringGroup]
    A list where each element has the following attributes:
    id str
    Unique identifier of the PeeringGroup.
    name str
    Unique human-readable name of the PeeringGroup.
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    peeringGroups List<Property Map>
    A list where each element has the following attributes:
    id String
    Unique identifier of the PeeringGroup.
    name String
    Unique human-readable name of the PeeringGroup.

    Supporting Types

    GetPeeringGroupPeeringGroup

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

    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.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg