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

sdm.PeeringGroupPeer

Explore with Pulumi AI

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

    PeeringGroupPeer represents the link between two PeeringGroups This resource can be imported using the import command.

    Create PeeringGroupPeer Resource

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

    Constructor syntax

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

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

    type: sdm:PeeringGroupPeer
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 PeeringGroupPeerArgs
    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 PeeringGroupPeerArgs
    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 PeeringGroupPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeeringGroupPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeeringGroupPeerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var peeringGroupPeerResource = new Sdm.PeeringGroupPeer("peeringGroupPeerResource", new()
{
    GroupId = "string",
    PeersWithGroupId = "string",
});

    example, err := sdm.NewPeeringGroupPeer(ctx, "peeringGroupPeerResource", &sdm.PeeringGroupPeerArgs{
	GroupId:          pulumi.String("string"),
	PeersWithGroupId: pulumi.String("string"),
})

    var peeringGroupPeerResource = new PeeringGroupPeer("peeringGroupPeerResource", PeeringGroupPeerArgs.builder()
    .groupId("string")
    .peersWithGroupId("string")
    .build());

    peering_group_peer_resource = sdm.PeeringGroupPeer("peeringGroupPeerResource",
    group_id="string",
    peers_with_group_id="string")

    const peeringGroupPeerResource = new sdm.PeeringGroupPeer("peeringGroupPeerResource", {
    groupId: "string",
    peersWithGroupId: "string",
});

    type: sdm:PeeringGroupPeer
properties:
    groupId: string
    peersWithGroupId: string

    PeeringGroupPeer 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 PeeringGroupPeer resource accepts the following input properties:

    GroupId string
    Group ID from which the link will originate.
    PeersWithGroupId string
    Peering Group ID to which Group ID will link.
    GroupId string
    Group ID from which the link will originate.
    PeersWithGroupId string
    Peering Group ID to which Group ID will link.
    groupId String
    Group ID from which the link will originate.
    peersWithGroupId String
    Peering Group ID to which Group ID will link.
    groupId string
    Group ID from which the link will originate.
    peersWithGroupId string
    Peering Group ID to which Group ID will link.
    group_id str
    Group ID from which the link will originate.
    peers_with_group_id str
    Peering Group ID to which Group ID will link.
    groupId String
    Group ID from which the link will originate.
    peersWithGroupId String
    Peering Group ID to which Group ID will link.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PeeringGroupPeer 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 PeeringGroupPeer Resource

    Get an existing PeeringGroupPeer 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?: PeeringGroupPeerState, opts?: CustomResourceOptions): PeeringGroupPeer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_id: Optional[str] = None,
        peers_with_group_id: Optional[str] = None) -> PeeringGroupPeer
    func GetPeeringGroupPeer(ctx *Context, name string, id IDInput, state *PeeringGroupPeerState, opts ...ResourceOption) (*PeeringGroupPeer, error)
    public static PeeringGroupPeer Get(string name, Input<string> id, PeeringGroupPeerState? state, CustomResourceOptions? opts = null)
    public static PeeringGroupPeer get(String name, Output<String> id, PeeringGroupPeerState 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:
    GroupId string
    Group ID from which the link will originate.
    PeersWithGroupId string
    Peering Group ID to which Group ID will link.
    GroupId string
    Group ID from which the link will originate.
    PeersWithGroupId string
    Peering Group ID to which Group ID will link.
    groupId String
    Group ID from which the link will originate.
    peersWithGroupId String
    Peering Group ID to which Group ID will link.
    groupId string
    Group ID from which the link will originate.
    peersWithGroupId string
    Peering Group ID to which Group ID will link.
    group_id str
    Group ID from which the link will originate.
    peers_with_group_id str
    Peering Group ID to which Group ID will link.
    groupId String
    Group ID from which the link will originate.
    peersWithGroupId String
    Peering Group ID to which Group ID will link.

    Import

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

    $ pulumi import sdm:index/peeringGroupPeer:PeeringGroupPeer example gp-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