1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. SystemBannerProfileParcel
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

sdwan.SystemBannerProfileParcel

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

    This resource can manage a System Banner profile parcel.

    • Minimum SD-WAN Manager version: 20.12.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.SystemBannerProfileParcel("example", {
        name: "Example",
        description: "My Example",
        featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        login: "My login banner",
        motd: "My motd banner",
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.SystemBannerProfileParcel("example",
        name="Example",
        description="My Example",
        feature_profile_id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        login="My login banner",
        motd="My motd banner")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdwan.NewSystemBannerProfileParcel(ctx, "example", &sdwan.SystemBannerProfileParcelArgs{
    			Name:             pulumi.String("Example"),
    			Description:      pulumi.String("My Example"),
    			FeatureProfileId: pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
    			Login:            pulumi.String("My login banner"),
    			Motd:             pulumi.String("My motd banner"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdwan = Pulumi.Sdwan;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Sdwan.SystemBannerProfileParcel("example", new()
        {
            Name = "Example",
            Description = "My Example",
            FeatureProfileId = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
            Login = "My login banner",
            Motd = "My motd banner",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.SystemBannerProfileParcel;
    import com.pulumi.sdwan.SystemBannerProfileParcelArgs;
    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 example = new SystemBannerProfileParcel("example", SystemBannerProfileParcelArgs.builder()        
                .name("Example")
                .description("My Example")
                .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .login("My login banner")
                .motd("My motd banner")
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:SystemBannerProfileParcel
        properties:
          name: Example
          description: My Example
          featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
          login: My login banner
          motd: My motd banner
    

    Create SystemBannerProfileParcel Resource

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

    Constructor syntax

    new SystemBannerProfileParcel(name: string, args: SystemBannerProfileParcelArgs, opts?: CustomResourceOptions);
    @overload
    def SystemBannerProfileParcel(resource_name: str,
                                  args: SystemBannerProfileParcelArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SystemBannerProfileParcel(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  feature_profile_id: Optional[str] = None,
                                  description: Optional[str] = None,
                                  login: Optional[str] = None,
                                  login_variable: Optional[str] = None,
                                  motd: Optional[str] = None,
                                  motd_variable: Optional[str] = None,
                                  name: Optional[str] = None)
    func NewSystemBannerProfileParcel(ctx *Context, name string, args SystemBannerProfileParcelArgs, opts ...ResourceOption) (*SystemBannerProfileParcel, error)
    public SystemBannerProfileParcel(string name, SystemBannerProfileParcelArgs args, CustomResourceOptions? opts = null)
    public SystemBannerProfileParcel(String name, SystemBannerProfileParcelArgs args)
    public SystemBannerProfileParcel(String name, SystemBannerProfileParcelArgs args, CustomResourceOptions options)
    
    type: sdwan:SystemBannerProfileParcel
    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 SystemBannerProfileParcelArgs
    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 SystemBannerProfileParcelArgs
    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 SystemBannerProfileParcelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemBannerProfileParcelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemBannerProfileParcelArgs
    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 systemBannerProfileParcelResource = new Sdwan.SystemBannerProfileParcel("systemBannerProfileParcelResource", new()
    {
        FeatureProfileId = "string",
        Description = "string",
        Login = "string",
        LoginVariable = "string",
        Motd = "string",
        MotdVariable = "string",
        Name = "string",
    });
    
    example, err := sdwan.NewSystemBannerProfileParcel(ctx, "systemBannerProfileParcelResource", &sdwan.SystemBannerProfileParcelArgs{
    	FeatureProfileId: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Login:            pulumi.String("string"),
    	LoginVariable:    pulumi.String("string"),
    	Motd:             pulumi.String("string"),
    	MotdVariable:     pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var systemBannerProfileParcelResource = new SystemBannerProfileParcel("systemBannerProfileParcelResource", SystemBannerProfileParcelArgs.builder()
        .featureProfileId("string")
        .description("string")
        .login("string")
        .loginVariable("string")
        .motd("string")
        .motdVariable("string")
        .name("string")
        .build());
    
    system_banner_profile_parcel_resource = sdwan.SystemBannerProfileParcel("systemBannerProfileParcelResource",
        feature_profile_id="string",
        description="string",
        login="string",
        login_variable="string",
        motd="string",
        motd_variable="string",
        name="string")
    
    const systemBannerProfileParcelResource = new sdwan.SystemBannerProfileParcel("systemBannerProfileParcelResource", {
        featureProfileId: "string",
        description: "string",
        login: "string",
        loginVariable: "string",
        motd: "string",
        motdVariable: "string",
        name: "string",
    });
    
    type: sdwan:SystemBannerProfileParcel
    properties:
        description: string
        featureProfileId: string
        login: string
        loginVariable: string
        motd: string
        motdVariable: string
        name: string
    

    SystemBannerProfileParcel Resource Properties

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

    Inputs

    The SystemBannerProfileParcel resource accepts the following input properties:

    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the profile parcel
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the profile parcel
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the profile parcel
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the profile parcel
    featureProfileId String
    Feature Profile ID
    description String
    The description of the profile parcel
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the profile parcel
    featureProfileId string
    Feature Profile ID
    description string
    The description of the profile parcel
    login string
    loginVariable string
    Variable name
    motd string
    motdVariable string
    Variable name
    name string
    The name of the profile parcel
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the profile parcel
    login str
    login_variable str
    Variable name
    motd str
    motd_variable str
    Variable name
    name str
    The name of the profile parcel
    featureProfileId String
    Feature Profile ID
    description String
    The description of the profile parcel
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the profile parcel

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the profile parcel
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the profile parcel
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the profile parcel
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the profile parcel
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the profile parcel
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the profile parcel

    Look up Existing SystemBannerProfileParcel Resource

    Get an existing SystemBannerProfileParcel 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?: SystemBannerProfileParcelState, opts?: CustomResourceOptions): SystemBannerProfileParcel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            feature_profile_id: Optional[str] = None,
            login: Optional[str] = None,
            login_variable: Optional[str] = None,
            motd: Optional[str] = None,
            motd_variable: Optional[str] = None,
            name: Optional[str] = None,
            version: Optional[int] = None) -> SystemBannerProfileParcel
    func GetSystemBannerProfileParcel(ctx *Context, name string, id IDInput, state *SystemBannerProfileParcelState, opts ...ResourceOption) (*SystemBannerProfileParcel, error)
    public static SystemBannerProfileParcel Get(string name, Input<string> id, SystemBannerProfileParcelState? state, CustomResourceOptions? opts = null)
    public static SystemBannerProfileParcel get(String name, Output<String> id, SystemBannerProfileParcelState 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:
    Description string
    The description of the profile parcel
    FeatureProfileId string
    Feature Profile ID
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the profile parcel
    Version int
    The version of the profile parcel
    Description string
    The description of the profile parcel
    FeatureProfileId string
    Feature Profile ID
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the profile parcel
    Version int
    The version of the profile parcel
    description String
    The description of the profile parcel
    featureProfileId String
    Feature Profile ID
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the profile parcel
    version Integer
    The version of the profile parcel
    description string
    The description of the profile parcel
    featureProfileId string
    Feature Profile ID
    login string
    loginVariable string
    Variable name
    motd string
    motdVariable string
    Variable name
    name string
    The name of the profile parcel
    version number
    The version of the profile parcel
    description str
    The description of the profile parcel
    feature_profile_id str
    Feature Profile ID
    login str
    login_variable str
    Variable name
    motd str
    motd_variable str
    Variable name
    name str
    The name of the profile parcel
    version int
    The version of the profile parcel
    description String
    The description of the profile parcel
    featureProfileId String
    Feature Profile ID
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the profile parcel
    version Number
    The version of the profile parcel

    Import

    $ pulumi import sdwan:index/systemBannerProfileParcel:SystemBannerProfileParcel example "f6b2c44c-693c-4763-b010-895aa3d236bd"
    

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

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi