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

sdm.PeeringGroupResource

Explore with Pulumi AI

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

    PeeringGroupResource represents the attachment between a PeeringGroup and a Resource. This resource can be imported using the import command.

    Create PeeringGroupResource Resource

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

    Constructor syntax

    new PeeringGroupResource(name: string, args?: PeeringGroupResourceArgs, opts?: CustomResourceOptions);
    @overload
    def PeeringGroupResource(resource_name: str,
                             args: Optional[PeeringGroupResourceArgs] = None,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def PeeringGroupResource(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             group_id: Optional[str] = None,
                             resource_id: Optional[str] = None)
    func NewPeeringGroupResource(ctx *Context, name string, args *PeeringGroupResourceArgs, opts ...ResourceOption) (*PeeringGroupResource, error)
    public PeeringGroupResource(string name, PeeringGroupResourceArgs? args = null, CustomResourceOptions? opts = null)
    public PeeringGroupResource(String name, PeeringGroupResourceArgs args)
    public PeeringGroupResource(String name, PeeringGroupResourceArgs args, CustomResourceOptions options)
    
    type: sdm:PeeringGroupResource
    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 PeeringGroupResourceArgs
    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 PeeringGroupResourceArgs
    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 PeeringGroupResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeeringGroupResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeeringGroupResourceArgs
    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 peeringGroupResourceResource = new Sdm.PeeringGroupResource("peeringGroupResourceResource", new()
    {
        GroupId = "string",
        ResourceId = "string",
    });
    
    example, err := sdm.NewPeeringGroupResource(ctx, "peeringGroupResourceResource", &sdm.PeeringGroupResourceArgs{
    	GroupId:    pulumi.String("string"),
    	ResourceId: pulumi.String("string"),
    })
    
    var peeringGroupResourceResource = new PeeringGroupResource("peeringGroupResourceResource", PeeringGroupResourceArgs.builder()
        .groupId("string")
        .resourceId("string")
        .build());
    
    peering_group_resource_resource = sdm.PeeringGroupResource("peeringGroupResourceResource",
        group_id="string",
        resource_id="string")
    
    const peeringGroupResourceResource = new sdm.PeeringGroupResource("peeringGroupResourceResource", {
        groupId: "string",
        resourceId: "string",
    });
    
    type: sdm:PeeringGroupResource
    properties:
        groupId: string
        resourceId: string
    

    PeeringGroupResource Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PeeringGroupResource resource accepts the following input properties:

    GroupId string
    Peering Group ID to which the resource will be attached to.
    ResourceId string
    Resource ID to be attached.
    GroupId string
    Peering Group ID to which the resource will be attached to.
    ResourceId string
    Resource ID to be attached.
    groupId String
    Peering Group ID to which the resource will be attached to.
    resourceId String
    Resource ID to be attached.
    groupId string
    Peering Group ID to which the resource will be attached to.
    resourceId string
    Resource ID to be attached.
    group_id str
    Peering Group ID to which the resource will be attached to.
    resource_id str
    Resource ID to be attached.
    groupId String
    Peering Group ID to which the resource will be attached to.
    resourceId String
    Resource ID to be attached.

    Outputs

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

    Get an existing PeeringGroupResource 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?: PeeringGroupResourceState, opts?: CustomResourceOptions): PeeringGroupResource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group_id: Optional[str] = None,
            resource_id: Optional[str] = None) -> PeeringGroupResource
    func GetPeeringGroupResource(ctx *Context, name string, id IDInput, state *PeeringGroupResourceState, opts ...ResourceOption) (*PeeringGroupResource, error)
    public static PeeringGroupResource Get(string name, Input<string> id, PeeringGroupResourceState? state, CustomResourceOptions? opts = null)
    public static PeeringGroupResource get(String name, Output<String> id, PeeringGroupResourceState 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
    Peering Group ID to which the resource will be attached to.
    ResourceId string
    Resource ID to be attached.
    GroupId string
    Peering Group ID to which the resource will be attached to.
    ResourceId string
    Resource ID to be attached.
    groupId String
    Peering Group ID to which the resource will be attached to.
    resourceId String
    Resource ID to be attached.
    groupId string
    Peering Group ID to which the resource will be attached to.
    resourceId string
    Resource ID to be attached.
    group_id str
    Peering Group ID to which the resource will be attached to.
    resource_id str
    Resource ID to be attached.
    groupId String
    Peering Group ID to which the resource will be attached to.
    resourceId String
    Resource ID to be attached.

    Import

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

    $ pulumi import sdm:index/peeringGroupResource:PeeringGroupResource example gr-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.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg