OspfAuthProfile resource
Create OspfAuthProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OspfAuthProfile(name: string, args?: OspfAuthProfileArgs, opts?: CustomResourceOptions);@overload
def OspfAuthProfile(resource_name: str,
args: Optional[OspfAuthProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def OspfAuthProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
md5s: Optional[Sequence[OspfAuthProfileMd5Args]] = None,
name: Optional[str] = None,
password: Optional[str] = None,
snippet: Optional[str] = None)func NewOspfAuthProfile(ctx *Context, name string, args *OspfAuthProfileArgs, opts ...ResourceOption) (*OspfAuthProfile, error)public OspfAuthProfile(string name, OspfAuthProfileArgs? args = null, CustomResourceOptions? opts = null)
public OspfAuthProfile(String name, OspfAuthProfileArgs args)
public OspfAuthProfile(String name, OspfAuthProfileArgs args, CustomResourceOptions options)
type: scm:OspfAuthProfile
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 OspfAuthProfileArgs
- 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 OspfAuthProfileArgs
- 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 OspfAuthProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OspfAuthProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OspfAuthProfileArgs
- 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 ospfAuthProfileResource = new Scm.OspfAuthProfile("ospfAuthProfileResource", new()
{
Device = "string",
Folder = "string",
Md5s = new[]
{
new Scm.Inputs.OspfAuthProfileMd5Args
{
Key = "string",
Name = 0,
Preferred = false,
},
},
Name = "string",
Password = "string",
Snippet = "string",
});
example, err := scm.NewOspfAuthProfile(ctx, "ospfAuthProfileResource", &scm.OspfAuthProfileArgs{
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Md5s: scm.OspfAuthProfileMd5Array{
&scm.OspfAuthProfileMd5Args{
Key: pulumi.String("string"),
Name: pulumi.Int(0),
Preferred: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
Password: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var ospfAuthProfileResource = new OspfAuthProfile("ospfAuthProfileResource", OspfAuthProfileArgs.builder()
.device("string")
.folder("string")
.md5s(OspfAuthProfileMd5Args.builder()
.key("string")
.name(0)
.preferred(false)
.build())
.name("string")
.password("string")
.snippet("string")
.build());
ospf_auth_profile_resource = scm.OspfAuthProfile("ospfAuthProfileResource",
device="string",
folder="string",
md5s=[{
"key": "string",
"name": 0,
"preferred": False,
}],
name="string",
password="string",
snippet="string")
const ospfAuthProfileResource = new scm.OspfAuthProfile("ospfAuthProfileResource", {
device: "string",
folder: "string",
md5s: [{
key: "string",
name: 0,
preferred: false,
}],
name: "string",
password: "string",
snippet: "string",
});
type: scm:OspfAuthProfile
properties:
device: string
folder: string
md5s:
- key: string
name: 0
preferred: false
name: string
password: string
snippet: string
OspfAuthProfile 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 OspfAuthProfile 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.- Md5s
List<Ospf
Auth Profile Md5> MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- Name string
- Profile name
- Password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- Md5s
[]Ospf
Auth Profile Md5Args MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- Name string
- Profile name
- Password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
List<Ospf
Auth Profile Md5> MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name String
- Profile name
- password String
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
Ospf
Auth Profile Md5[] MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name string
- Profile name
- password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
Sequence[Ospf
Auth Profile Md5Args] MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name str
- Profile name
- password str
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s List<Property Map>
MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name String
- Profile name
- password String
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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 OspfAuthProfile 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 OspfAuthProfile Resource
Get an existing OspfAuthProfile 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?: OspfAuthProfileState, opts?: CustomResourceOptions): OspfAuthProfile@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,
md5s: Optional[Sequence[OspfAuthProfileMd5Args]] = None,
name: Optional[str] = None,
password: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> OspfAuthProfilefunc GetOspfAuthProfile(ctx *Context, name string, id IDInput, state *OspfAuthProfileState, opts ...ResourceOption) (*OspfAuthProfile, error)public static OspfAuthProfile Get(string name, Input<string> id, OspfAuthProfileState? state, CustomResourceOptions? opts = null)public static OspfAuthProfile get(String name, Output<String> id, OspfAuthProfileState state, CustomResourceOptions options)resources: _: type: scm:OspfAuthProfile 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.- Md5s
List<Ospf
Auth Profile Md5> MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- Name string
- Profile name
- Password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- Md5s
[]Ospf
Auth Profile Md5Args MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- Name string
- Profile name
- Password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
List<Ospf
Auth Profile Md5> MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name String
- Profile name
- password String
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
Ospf
Auth Profile Md5[] MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name string
- Profile name
- password string
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s
Sequence[Ospf
Auth Profile Md5Args] MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name str
- Profile name
- password str
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- 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.- md5s List<Property Map>
MD5s
ℹ️ Note: You must specify exactly one of
md5andpassword.- name String
- Profile name
- password String
Password
ℹ️ Note: You must specify exactly one of
md5andpassword.- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
Supporting Types
OspfAuthProfileMd5, OspfAuthProfileMd5Args
Import
The following command can be used to import a resource not managed by Terraform:
bash
$ pulumi import scm:index/ospfAuthProfile:OspfAuthProfile example folder:::id
or
bash
$ pulumi import scm:index/ospfAuthProfile:OspfAuthProfile example :snippet::id
or
bash
$ pulumi import scm:index/ospfAuthProfile:OspfAuthProfile example ::device:id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
