1. Packages
  2. Vkcs Provider
  3. API Docs
  4. DcBgpStaticAnnounce
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.DcBgpStaticAnnounce

Explore with Pulumi AI

Manages a direct connect BGP Static Announce resource.

Note: This resource requires Sprut SDN to be enabled in your project.

New since v0.5.0.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const dcBgpStaticAnnounce = new vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounce", {
    description: "tf-example-description",
    dcBgpId: vkcs_dc_bgp_instance.dc_bgp_instance.id,
    network: "192.168.1.0/24",
    gateway: "192.168.1.3",
});
Copy
import pulumi
import pulumi_vkcs as vkcs

dc_bgp_static_announce = vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounce",
    description="tf-example-description",
    dc_bgp_id=vkcs_dc_bgp_instance["dc_bgp_instance"]["id"],
    network="192.168.1.0/24",
    gateway="192.168.1.3")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewDcBgpStaticAnnounce(ctx, "dcBgpStaticAnnounce", &vkcs.DcBgpStaticAnnounceArgs{
			Description: pulumi.String("tf-example-description"),
			DcBgpId:     pulumi.Any(vkcs_dc_bgp_instance.Dc_bgp_instance.Id),
			Network:     pulumi.String("192.168.1.0/24"),
			Gateway:     pulumi.String("192.168.1.3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var dcBgpStaticAnnounce = new Vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounce", new()
    {
        Description = "tf-example-description",
        DcBgpId = vkcs_dc_bgp_instance.Dc_bgp_instance.Id,
        Network = "192.168.1.0/24",
        Gateway = "192.168.1.3",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.DcBgpStaticAnnounce;
import com.pulumi.vkcs.DcBgpStaticAnnounceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var dcBgpStaticAnnounce = new DcBgpStaticAnnounce("dcBgpStaticAnnounce", DcBgpStaticAnnounceArgs.builder()
            .description("tf-example-description")
            .dcBgpId(vkcs_dc_bgp_instance.dc_bgp_instance().id())
            .network("192.168.1.0/24")
            .gateway("192.168.1.3")
            .build());

    }
}
Copy
resources:
  dcBgpStaticAnnounce:
    type: vkcs:DcBgpStaticAnnounce
    properties:
      description: tf-example-description
      dcBgpId: ${vkcs_dc_bgp_instance.dc_bgp_instance.id}
      network: 192.168.1.0/24
      gateway: 192.168.1.3
Copy

Create DcBgpStaticAnnounce Resource

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

Constructor syntax

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

@overload
def DcBgpStaticAnnounce(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        dc_bgp_id: Optional[str] = None,
                        gateway: Optional[str] = None,
                        network: Optional[str] = None,
                        description: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        name: Optional[str] = None,
                        region: Optional[str] = None)
func NewDcBgpStaticAnnounce(ctx *Context, name string, args DcBgpStaticAnnounceArgs, opts ...ResourceOption) (*DcBgpStaticAnnounce, error)
public DcBgpStaticAnnounce(string name, DcBgpStaticAnnounceArgs args, CustomResourceOptions? opts = null)
public DcBgpStaticAnnounce(String name, DcBgpStaticAnnounceArgs args)
public DcBgpStaticAnnounce(String name, DcBgpStaticAnnounceArgs args, CustomResourceOptions options)
type: vkcs:DcBgpStaticAnnounce
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DcBgpStaticAnnounceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DcBgpStaticAnnounceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DcBgpStaticAnnounceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DcBgpStaticAnnounceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DcBgpStaticAnnounceArgs
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 dcBgpStaticAnnounceResource = new Vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounceResource", new()
{
    DcBgpId = "string",
    Gateway = "string",
    Network = "string",
    Description = "string",
    Enabled = false,
    Name = "string",
    Region = "string",
});
Copy
example, err := vkcs.NewDcBgpStaticAnnounce(ctx, "dcBgpStaticAnnounceResource", &vkcs.DcBgpStaticAnnounceArgs{
	DcBgpId:     pulumi.String("string"),
	Gateway:     pulumi.String("string"),
	Network:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	Region:      pulumi.String("string"),
})
Copy
var dcBgpStaticAnnounceResource = new DcBgpStaticAnnounce("dcBgpStaticAnnounceResource", DcBgpStaticAnnounceArgs.builder()
    .dcBgpId("string")
    .gateway("string")
    .network("string")
    .description("string")
    .enabled(false)
    .name("string")
    .region("string")
    .build());
Copy
dc_bgp_static_announce_resource = vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounceResource",
    dc_bgp_id="string",
    gateway="string",
    network="string",
    description="string",
    enabled=False,
    name="string",
    region="string")
Copy
const dcBgpStaticAnnounceResource = new vkcs.DcBgpStaticAnnounce("dcBgpStaticAnnounceResource", {
    dcBgpId: "string",
    gateway: "string",
    network: "string",
    description: "string",
    enabled: false,
    name: "string",
    region: "string",
});
Copy
type: vkcs:DcBgpStaticAnnounce
properties:
    dcBgpId: string
    description: string
    enabled: false
    gateway: string
    name: string
    network: string
    region: string
Copy

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

DcBgpId This property is required. string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
Gateway This property is required. string
required string → IP address of gateway. Changing this creates a new resource
Network This property is required. string
required string → Subnet in CIDR notation. Changing this creates a new resource
Description string
optional string → Description of the BGP neighbor
Enabled bool
optional boolean → Enable or disable item. Default is true
Name string
optional string → Name of the BGP neighbor
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
DcBgpId This property is required. string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
Gateway This property is required. string
required string → IP address of gateway. Changing this creates a new resource
Network This property is required. string
required string → Subnet in CIDR notation. Changing this creates a new resource
Description string
optional string → Description of the BGP neighbor
Enabled bool
optional boolean → Enable or disable item. Default is true
Name string
optional string → Name of the BGP neighbor
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
dcBgpId This property is required. String
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
gateway This property is required. String
required string → IP address of gateway. Changing this creates a new resource
network This property is required. String
required string → Subnet in CIDR notation. Changing this creates a new resource
description String
optional string → Description of the BGP neighbor
enabled Boolean
optional boolean → Enable or disable item. Default is true
name String
optional string → Name of the BGP neighbor
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
dcBgpId This property is required. string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
gateway This property is required. string
required string → IP address of gateway. Changing this creates a new resource
network This property is required. string
required string → Subnet in CIDR notation. Changing this creates a new resource
description string
optional string → Description of the BGP neighbor
enabled boolean
optional boolean → Enable or disable item. Default is true
name string
optional string → Name of the BGP neighbor
region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
dc_bgp_id This property is required. str
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
gateway This property is required. str
required string → IP address of gateway. Changing this creates a new resource
network This property is required. str
required string → Subnet in CIDR notation. Changing this creates a new resource
description str
optional string → Description of the BGP neighbor
enabled bool
optional boolean → Enable or disable item. Default is true
name str
optional string → Name of the BGP neighbor
region str
optional string → The region to fetch availability zones from, defaults to the provider's region.
dcBgpId This property is required. String
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
gateway This property is required. String
required string → IP address of gateway. Changing this creates a new resource
network This property is required. String
required string → Subnet in CIDR notation. Changing this creates a new resource
description String
optional string → Description of the BGP neighbor
enabled Boolean
optional boolean → Enable or disable item. Default is true
name String
optional string → Name of the BGP neighbor
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.

Outputs

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

CreatedAt string
string → Creation timestamp
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
string → Update timestamp
CreatedAt string
string → Creation timestamp
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
string → Update timestamp
createdAt String
string → Creation timestamp
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
string → Update timestamp
createdAt string
string → Creation timestamp
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
string → Update timestamp
created_at str
string → Creation timestamp
id str
The provider-assigned unique ID for this managed resource.
updated_at str
string → Update timestamp
createdAt String
string → Creation timestamp
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
string → Update timestamp

Look up Existing DcBgpStaticAnnounce Resource

Get an existing DcBgpStaticAnnounce 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?: DcBgpStaticAnnounceState, opts?: CustomResourceOptions): DcBgpStaticAnnounce
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        dc_bgp_id: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        gateway: Optional[str] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        region: Optional[str] = None,
        updated_at: Optional[str] = None) -> DcBgpStaticAnnounce
func GetDcBgpStaticAnnounce(ctx *Context, name string, id IDInput, state *DcBgpStaticAnnounceState, opts ...ResourceOption) (*DcBgpStaticAnnounce, error)
public static DcBgpStaticAnnounce Get(string name, Input<string> id, DcBgpStaticAnnounceState? state, CustomResourceOptions? opts = null)
public static DcBgpStaticAnnounce get(String name, Output<String> id, DcBgpStaticAnnounceState state, CustomResourceOptions options)
resources:  _:    type: vkcs:DcBgpStaticAnnounce    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
string → Creation timestamp
DcBgpId string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
Description string
optional string → Description of the BGP neighbor
Enabled bool
optional boolean → Enable or disable item. Default is true
Gateway string
required string → IP address of gateway. Changing this creates a new resource
Name string
optional string → Name of the BGP neighbor
Network string
required string → Subnet in CIDR notation. Changing this creates a new resource
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
UpdatedAt string
string → Update timestamp
CreatedAt string
string → Creation timestamp
DcBgpId string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
Description string
optional string → Description of the BGP neighbor
Enabled bool
optional boolean → Enable or disable item. Default is true
Gateway string
required string → IP address of gateway. Changing this creates a new resource
Name string
optional string → Name of the BGP neighbor
Network string
required string → Subnet in CIDR notation. Changing this creates a new resource
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
UpdatedAt string
string → Update timestamp
createdAt String
string → Creation timestamp
dcBgpId String
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
description String
optional string → Description of the BGP neighbor
enabled Boolean
optional boolean → Enable or disable item. Default is true
gateway String
required string → IP address of gateway. Changing this creates a new resource
name String
optional string → Name of the BGP neighbor
network String
required string → Subnet in CIDR notation. Changing this creates a new resource
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
updatedAt String
string → Update timestamp
createdAt string
string → Creation timestamp
dcBgpId string
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
description string
optional string → Description of the BGP neighbor
enabled boolean
optional boolean → Enable or disable item. Default is true
gateway string
required string → IP address of gateway. Changing this creates a new resource
name string
optional string → Name of the BGP neighbor
network string
required string → Subnet in CIDR notation. Changing this creates a new resource
region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
updatedAt string
string → Update timestamp
created_at str
string → Creation timestamp
dc_bgp_id str
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
description str
optional string → Description of the BGP neighbor
enabled bool
optional boolean → Enable or disable item. Default is true
gateway str
required string → IP address of gateway. Changing this creates a new resource
name str
optional string → Name of the BGP neighbor
network str
required string → Subnet in CIDR notation. Changing this creates a new resource
region str
optional string → The region to fetch availability zones from, defaults to the provider's region.
updated_at str
string → Update timestamp
createdAt String
string → Creation timestamp
dcBgpId String
required string → Direct Connect BGP ID to attach. Changing this creates a new resource
description String
optional string → Description of the BGP neighbor
enabled Boolean
optional boolean → Enable or disable item. Default is true
gateway String
required string → IP address of gateway. Changing this creates a new resource
name String
optional string → Name of the BGP neighbor
network String
required string → Subnet in CIDR notation. Changing this creates a new resource
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
updatedAt String
string → Update timestamp

Import

Direct connect BGP instance can be imported using the id, e.g.

$ pulumi import vkcs:index/dcBgpStaticAnnounce:DcBgpStaticAnnounce mydcbgpstaticannounce 8a1d9812-305b-468f-8ae5-833e181b01a8
Copy

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

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.