1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. PartnerAttachment
DigitalOcean v4.43.0 published on Wednesday, Apr 30, 2025 by Pulumi

digitalocean.PartnerAttachment

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.43.0 published on Wednesday, Apr 30, 2025 by Pulumi

    Create PartnerAttachment Resource

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

    Constructor syntax

    new PartnerAttachment(name: string, args: PartnerAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def PartnerAttachment(resource_name: str,
                          args: PartnerAttachmentArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def PartnerAttachment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          connection_bandwidth_in_mbps: Optional[int] = None,
                          naas_provider: Optional[str] = None,
                          region: Optional[str] = None,
                          vpc_ids: Optional[Sequence[str]] = None,
                          bgp: Optional[PartnerAttachmentBgpArgs] = None,
                          name: Optional[str] = None)
    func NewPartnerAttachment(ctx *Context, name string, args PartnerAttachmentArgs, opts ...ResourceOption) (*PartnerAttachment, error)
    public PartnerAttachment(string name, PartnerAttachmentArgs args, CustomResourceOptions? opts = null)
    public PartnerAttachment(String name, PartnerAttachmentArgs args)
    public PartnerAttachment(String name, PartnerAttachmentArgs args, CustomResourceOptions options)
    
    type: digitalocean:PartnerAttachment
    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 PartnerAttachmentArgs
    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 PartnerAttachmentArgs
    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 PartnerAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PartnerAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PartnerAttachmentArgs
    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 partnerAttachmentResource = new DigitalOcean.PartnerAttachment("partnerAttachmentResource", new()
    {
        ConnectionBandwidthInMbps = 0,
        NaasProvider = "string",
        Region = "string",
        VpcIds = new[]
        {
            "string",
        },
        Bgp = new DigitalOcean.Inputs.PartnerAttachmentBgpArgs
        {
            AuthKey = "string",
            LocalRouterIp = "string",
            PeerRouterAsn = 0,
            PeerRouterIp = "string",
        },
        Name = "string",
    });
    
    example, err := digitalocean.NewPartnerAttachment(ctx, "partnerAttachmentResource", &digitalocean.PartnerAttachmentArgs{
    	ConnectionBandwidthInMbps: pulumi.Int(0),
    	NaasProvider:              pulumi.String("string"),
    	Region:                    pulumi.String("string"),
    	VpcIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Bgp: &digitalocean.PartnerAttachmentBgpArgs{
    		AuthKey:       pulumi.String("string"),
    		LocalRouterIp: pulumi.String("string"),
    		PeerRouterAsn: pulumi.Int(0),
    		PeerRouterIp:  pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var partnerAttachmentResource = new PartnerAttachment("partnerAttachmentResource", PartnerAttachmentArgs.builder()
        .connectionBandwidthInMbps(0)
        .naasProvider("string")
        .region("string")
        .vpcIds("string")
        .bgp(PartnerAttachmentBgpArgs.builder()
            .authKey("string")
            .localRouterIp("string")
            .peerRouterAsn(0)
            .peerRouterIp("string")
            .build())
        .name("string")
        .build());
    
    partner_attachment_resource = digitalocean.PartnerAttachment("partnerAttachmentResource",
        connection_bandwidth_in_mbps=0,
        naas_provider="string",
        region="string",
        vpc_ids=["string"],
        bgp={
            "auth_key": "string",
            "local_router_ip": "string",
            "peer_router_asn": 0,
            "peer_router_ip": "string",
        },
        name="string")
    
    const partnerAttachmentResource = new digitalocean.PartnerAttachment("partnerAttachmentResource", {
        connectionBandwidthInMbps: 0,
        naasProvider: "string",
        region: "string",
        vpcIds: ["string"],
        bgp: {
            authKey: "string",
            localRouterIp: "string",
            peerRouterAsn: 0,
            peerRouterIp: "string",
        },
        name: "string",
    });
    
    type: digitalocean:PartnerAttachment
    properties:
        bgp:
            authKey: string
            localRouterIp: string
            peerRouterAsn: 0
            peerRouterIp: string
        connectionBandwidthInMbps: 0
        naasProvider: string
        name: string
        region: string
        vpcIds:
            - string
    

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

    ConnectionBandwidthInMbps int
    The connection bandwidth in Mbps
    NaasProvider string
    The NaaS provider
    Region string
    The region where the Partner Attachment will be created
    VpcIds List<string>
    The list of VPC IDs to attach the Partner Attachment to
    Bgp Pulumi.DigitalOcean.Inputs.PartnerAttachmentBgp
    Name string
    The name of the Partner Attachment
    ConnectionBandwidthInMbps int
    The connection bandwidth in Mbps
    NaasProvider string
    The NaaS provider
    Region string
    The region where the Partner Attachment will be created
    VpcIds []string
    The list of VPC IDs to attach the Partner Attachment to
    Bgp PartnerAttachmentBgpArgs
    Name string
    The name of the Partner Attachment
    connectionBandwidthInMbps Integer
    The connection bandwidth in Mbps
    naasProvider String
    The NaaS provider
    region String
    The region where the Partner Attachment will be created
    vpcIds List<String>
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgp
    name String
    The name of the Partner Attachment
    connectionBandwidthInMbps number
    The connection bandwidth in Mbps
    naasProvider string
    The NaaS provider
    region string
    The region where the Partner Attachment will be created
    vpcIds string[]
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgp
    name string
    The name of the Partner Attachment
    connection_bandwidth_in_mbps int
    The connection bandwidth in Mbps
    naas_provider str
    The NaaS provider
    region str
    The region where the Partner Attachment will be created
    vpc_ids Sequence[str]
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgpArgs
    name str
    The name of the Partner Attachment
    connectionBandwidthInMbps Number
    The connection bandwidth in Mbps
    naasProvider String
    The NaaS provider
    region String
    The region where the Partner Attachment will be created
    vpcIds List<String>
    The list of VPC IDs to attach the Partner Attachment to
    bgp Property Map
    name String
    The name of the Partner Attachment

    Outputs

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

    CreatedAt string
    The date and time when the Partner Attachment was created
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the Partner Attachment
    CreatedAt string
    The date and time when the Partner Attachment was created
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the Partner Attachment
    createdAt String
    The date and time when the Partner Attachment was created
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the Partner Attachment
    createdAt string
    The date and time when the Partner Attachment was created
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the Partner Attachment
    created_at str
    The date and time when the Partner Attachment was created
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The state of the Partner Attachment
    createdAt String
    The date and time when the Partner Attachment was created
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the Partner Attachment

    Look up Existing PartnerAttachment Resource

    Get an existing PartnerAttachment 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?: PartnerAttachmentState, opts?: CustomResourceOptions): PartnerAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bgp: Optional[PartnerAttachmentBgpArgs] = None,
            connection_bandwidth_in_mbps: Optional[int] = None,
            created_at: Optional[str] = None,
            naas_provider: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            state: Optional[str] = None,
            vpc_ids: Optional[Sequence[str]] = None) -> PartnerAttachment
    func GetPartnerAttachment(ctx *Context, name string, id IDInput, state *PartnerAttachmentState, opts ...ResourceOption) (*PartnerAttachment, error)
    public static PartnerAttachment Get(string name, Input<string> id, PartnerAttachmentState? state, CustomResourceOptions? opts = null)
    public static PartnerAttachment get(String name, Output<String> id, PartnerAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: digitalocean:PartnerAttachment    get:      id: ${id}
    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:
    Bgp Pulumi.DigitalOcean.Inputs.PartnerAttachmentBgp
    ConnectionBandwidthInMbps int
    The connection bandwidth in Mbps
    CreatedAt string
    The date and time when the Partner Attachment was created
    NaasProvider string
    The NaaS provider
    Name string
    The name of the Partner Attachment
    Region string
    The region where the Partner Attachment will be created
    State string
    The state of the Partner Attachment
    VpcIds List<string>
    The list of VPC IDs to attach the Partner Attachment to
    Bgp PartnerAttachmentBgpArgs
    ConnectionBandwidthInMbps int
    The connection bandwidth in Mbps
    CreatedAt string
    The date and time when the Partner Attachment was created
    NaasProvider string
    The NaaS provider
    Name string
    The name of the Partner Attachment
    Region string
    The region where the Partner Attachment will be created
    State string
    The state of the Partner Attachment
    VpcIds []string
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgp
    connectionBandwidthInMbps Integer
    The connection bandwidth in Mbps
    createdAt String
    The date and time when the Partner Attachment was created
    naasProvider String
    The NaaS provider
    name String
    The name of the Partner Attachment
    region String
    The region where the Partner Attachment will be created
    state String
    The state of the Partner Attachment
    vpcIds List<String>
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgp
    connectionBandwidthInMbps number
    The connection bandwidth in Mbps
    createdAt string
    The date and time when the Partner Attachment was created
    naasProvider string
    The NaaS provider
    name string
    The name of the Partner Attachment
    region string
    The region where the Partner Attachment will be created
    state string
    The state of the Partner Attachment
    vpcIds string[]
    The list of VPC IDs to attach the Partner Attachment to
    bgp PartnerAttachmentBgpArgs
    connection_bandwidth_in_mbps int
    The connection bandwidth in Mbps
    created_at str
    The date and time when the Partner Attachment was created
    naas_provider str
    The NaaS provider
    name str
    The name of the Partner Attachment
    region str
    The region where the Partner Attachment will be created
    state str
    The state of the Partner Attachment
    vpc_ids Sequence[str]
    The list of VPC IDs to attach the Partner Attachment to
    bgp Property Map
    connectionBandwidthInMbps Number
    The connection bandwidth in Mbps
    createdAt String
    The date and time when the Partner Attachment was created
    naasProvider String
    The NaaS provider
    name String
    The name of the Partner Attachment
    region String
    The region where the Partner Attachment will be created
    state String
    The state of the Partner Attachment
    vpcIds List<String>
    The list of VPC IDs to attach the Partner Attachment to

    Supporting Types

    PartnerAttachmentBgp, PartnerAttachmentBgpArgs

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.43.0 published on Wednesday, Apr 30, 2025 by Pulumi