BgpAuthProfile resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const scmBgpAuthProfile = new scm.BgpAuthProfile("scm_bgp_auth_profile", {
folder: "ngfw-shared",
name: "scm_bgp_auth_profile",
secret: "ExampleSecret123",
});
import pulumi
import pulumi_scm as scm
scm_bgp_auth_profile = scm.BgpAuthProfile("scm_bgp_auth_profile",
folder="ngfw-shared",
name="scm_bgp_auth_profile",
secret="ExampleSecret123")
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scm.NewBgpAuthProfile(ctx, "scm_bgp_auth_profile", &scm.BgpAuthProfileArgs{
Folder: pulumi.String("ngfw-shared"),
Name: pulumi.String("scm_bgp_auth_profile"),
Secret: pulumi.String("ExampleSecret123"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var scmBgpAuthProfile = new Scm.BgpAuthProfile("scm_bgp_auth_profile", new()
{
Folder = "ngfw-shared",
Name = "scm_bgp_auth_profile",
Secret = "ExampleSecret123",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.BgpAuthProfile;
import com.pulumi.scm.BgpAuthProfileArgs;
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 scmBgpAuthProfile = new BgpAuthProfile("scmBgpAuthProfile", BgpAuthProfileArgs.builder()
.folder("ngfw-shared")
.name("scm_bgp_auth_profile")
.secret("ExampleSecret123")
.build());
}
}
resources:
scmBgpAuthProfile:
type: scm:BgpAuthProfile
name: scm_bgp_auth_profile
properties:
folder: ngfw-shared
name: scm_bgp_auth_profile
secret: ExampleSecret123
Create BgpAuthProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BgpAuthProfile(name: string, args?: BgpAuthProfileArgs, opts?: CustomResourceOptions);@overload
def BgpAuthProfile(resource_name: str,
args: Optional[BgpAuthProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def BgpAuthProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
secret: Optional[str] = None,
snippet: Optional[str] = None)func NewBgpAuthProfile(ctx *Context, name string, args *BgpAuthProfileArgs, opts ...ResourceOption) (*BgpAuthProfile, error)public BgpAuthProfile(string name, BgpAuthProfileArgs? args = null, CustomResourceOptions? opts = null)
public BgpAuthProfile(String name, BgpAuthProfileArgs args)
public BgpAuthProfile(String name, BgpAuthProfileArgs args, CustomResourceOptions options)
type: scm:BgpAuthProfile
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 BgpAuthProfileArgs
- 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 BgpAuthProfileArgs
- 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 BgpAuthProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BgpAuthProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BgpAuthProfileArgs
- 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 bgpAuthProfileResource = new Scm.BgpAuthProfile("bgpAuthProfileResource", new()
{
Device = "string",
Folder = "string",
Name = "string",
Secret = "string",
Snippet = "string",
});
example, err := scm.NewBgpAuthProfile(ctx, "bgpAuthProfileResource", &scm.BgpAuthProfileArgs{
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Secret: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var bgpAuthProfileResource = new BgpAuthProfile("bgpAuthProfileResource", BgpAuthProfileArgs.builder()
.device("string")
.folder("string")
.name("string")
.secret("string")
.snippet("string")
.build());
bgp_auth_profile_resource = scm.BgpAuthProfile("bgpAuthProfileResource",
device="string",
folder="string",
name="string",
secret="string",
snippet="string")
const bgpAuthProfileResource = new scm.BgpAuthProfile("bgpAuthProfileResource", {
device: "string",
folder: "string",
name: "string",
secret: "string",
snippet: "string",
});
type: scm:BgpAuthProfile
properties:
device: string
folder: string
name: string
secret: string
snippet: string
BgpAuthProfile 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 BgpAuthProfile resource accepts the following input properties:
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- Profile name
- Secret string
- BGP authentication key
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- Profile name
- Secret string
- BGP authentication key
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- Profile name
- secret String
- BGP authentication key
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- device string
- The device in which the resource is defined
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name string
- Profile name
- secret string
- BGP authentication key
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- device str
- The device in which the resource is defined
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name str
- Profile name
- secret str
- BGP authentication key
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- Profile name
- secret String
- BGP authentication key
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
Outputs
All input properties are implicitly available as output properties. Additionally, the BgpAuthProfile resource produces the following output properties:
- Encrypted
Values Dictionary<string, string> - Map of sensitive values returned from the API.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- Encrypted
Values map[string]string - Map of sensitive values returned from the API.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- encrypted
Values Map<String,String> - Map of sensitive values returned from the API.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
- encrypted
Values {[key: string]: string} - Map of sensitive values returned from the API.
- id string
- The provider-assigned unique ID for this managed resource.
- tfid string
- encrypted_
values Mapping[str, str] - Map of sensitive values returned from the API.
- id str
- The provider-assigned unique ID for this managed resource.
- tfid str
- encrypted
Values Map<String> - Map of sensitive values returned from the API.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
Look up Existing BgpAuthProfile Resource
Get an existing BgpAuthProfile 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?: BgpAuthProfileState, opts?: CustomResourceOptions): BgpAuthProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
encrypted_values: Optional[Mapping[str, str]] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
secret: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> BgpAuthProfilefunc GetBgpAuthProfile(ctx *Context, name string, id IDInput, state *BgpAuthProfileState, opts ...ResourceOption) (*BgpAuthProfile, error)public static BgpAuthProfile Get(string name, Input<string> id, BgpAuthProfileState? state, CustomResourceOptions? opts = null)public static BgpAuthProfile get(String name, Output<String> id, BgpAuthProfileState state, CustomResourceOptions options)resources: _: type: scm:BgpAuthProfile 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.
- Device string
- The device in which the resource is defined
- Encrypted
Values Dictionary<string, string> - Map of sensitive values returned from the API.
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- Profile name
- Secret string
- BGP authentication key
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Tfid string
- Device string
- The device in which the resource is defined
- Encrypted
Values map[string]string - Map of sensitive values returned from the API.
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- Profile name
- Secret string
- BGP authentication key
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Tfid string
- device String
- The device in which the resource is defined
- encrypted
Values Map<String,String> - Map of sensitive values returned from the API.
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- Profile name
- secret String
- BGP authentication key
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
- device string
- The device in which the resource is defined
- encrypted
Values {[key: string]: string} - Map of sensitive values returned from the API.
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name string
- Profile name
- secret string
- BGP authentication key
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid string
- device str
- The device in which the resource is defined
- encrypted_
values Mapping[str, str] - Map of sensitive values returned from the API.
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name str
- Profile name
- secret str
- BGP authentication key
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid str
- device String
- The device in which the resource is defined
- encrypted
Values Map<String> - Map of sensitive values returned from the API.
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- Profile name
- secret String
- BGP authentication key
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
