MotdBannerSetting resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const motdExample = new scm.MotdBannerSetting("motd_example", {
folder: "All",
motdAndBanner: {
motdEnable: true,
message: "Test Message",
motdDoNotDisplayAgain: false,
motdTitle: "Test title",
motdColor: "color1",
severity: "warning",
bannerHeader: "Test banner Header",
bannerHeaderColor: "color1",
bannerHeaderTextColor: "color1",
bannerHeaderFooterMatch: true,
bannerFooter: "Test banner Footer",
bannerFooterColor: "color1",
bannerFooterTextColor: "color1",
},
});
import pulumi
import pulumi_scm as scm
motd_example = scm.MotdBannerSetting("motd_example",
folder="All",
motd_and_banner={
"motd_enable": True,
"message": "Test Message",
"motd_do_not_display_again": False,
"motd_title": "Test title",
"motd_color": "color1",
"severity": "warning",
"banner_header": "Test banner Header",
"banner_header_color": "color1",
"banner_header_text_color": "color1",
"banner_header_footer_match": True,
"banner_footer": "Test banner Footer",
"banner_footer_color": "color1",
"banner_footer_text_color": "color1",
})
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.NewMotdBannerSetting(ctx, "motd_example", &scm.MotdBannerSettingArgs{
Folder: pulumi.String("All"),
MotdAndBanner: &scm.MotdBannerSettingMotdAndBannerArgs{
MotdEnable: pulumi.Bool(true),
Message: pulumi.String("Test Message"),
MotdDoNotDisplayAgain: pulumi.Bool(false),
MotdTitle: pulumi.String("Test title"),
MotdColor: pulumi.String("color1"),
Severity: pulumi.String("warning"),
BannerHeader: pulumi.String("Test banner Header"),
BannerHeaderColor: pulumi.String("color1"),
BannerHeaderTextColor: pulumi.String("color1"),
BannerHeaderFooterMatch: pulumi.Bool(true),
BannerFooter: pulumi.String("Test banner Footer"),
BannerFooterColor: pulumi.String("color1"),
BannerFooterTextColor: pulumi.String("color1"),
},
})
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 motdExample = new Scm.MotdBannerSetting("motd_example", new()
{
Folder = "All",
MotdAndBanner = new Scm.Inputs.MotdBannerSettingMotdAndBannerArgs
{
MotdEnable = true,
Message = "Test Message",
MotdDoNotDisplayAgain = false,
MotdTitle = "Test title",
MotdColor = "color1",
Severity = "warning",
BannerHeader = "Test banner Header",
BannerHeaderColor = "color1",
BannerHeaderTextColor = "color1",
BannerHeaderFooterMatch = true,
BannerFooter = "Test banner Footer",
BannerFooterColor = "color1",
BannerFooterTextColor = "color1",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.MotdBannerSetting;
import com.pulumi.scm.MotdBannerSettingArgs;
import com.pulumi.scm.inputs.MotdBannerSettingMotdAndBannerArgs;
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 motdExample = new MotdBannerSetting("motdExample", MotdBannerSettingArgs.builder()
.folder("All")
.motdAndBanner(MotdBannerSettingMotdAndBannerArgs.builder()
.motdEnable(true)
.message("Test Message")
.motdDoNotDisplayAgain(false)
.motdTitle("Test title")
.motdColor("color1")
.severity("warning")
.bannerHeader("Test banner Header")
.bannerHeaderColor("color1")
.bannerHeaderTextColor("color1")
.bannerHeaderFooterMatch(true)
.bannerFooter("Test banner Footer")
.bannerFooterColor("color1")
.bannerFooterTextColor("color1")
.build())
.build());
}
}
resources:
motdExample:
type: scm:MotdBannerSetting
name: motd_example
properties:
folder: All
motdAndBanner:
motdEnable: true
message: Test Message
motdDoNotDisplayAgain: false
motdTitle: Test title
motdColor: color1
severity: warning
bannerHeader: Test banner Header
bannerHeaderColor: color1
bannerHeaderTextColor: color1
bannerHeaderFooterMatch: true
bannerFooter: Test banner Footer
bannerFooterColor: color1
bannerFooterTextColor: color1
Create MotdBannerSetting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MotdBannerSetting(name: string, args?: MotdBannerSettingArgs, opts?: CustomResourceOptions);@overload
def MotdBannerSetting(resource_name: str,
args: Optional[MotdBannerSettingArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def MotdBannerSetting(resource_name: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
motd_and_banner: Optional[MotdBannerSettingMotdAndBannerArgs] = None,
snippet: Optional[str] = None)func NewMotdBannerSetting(ctx *Context, name string, args *MotdBannerSettingArgs, opts ...ResourceOption) (*MotdBannerSetting, error)public MotdBannerSetting(string name, MotdBannerSettingArgs? args = null, CustomResourceOptions? opts = null)
public MotdBannerSetting(String name, MotdBannerSettingArgs args)
public MotdBannerSetting(String name, MotdBannerSettingArgs args, CustomResourceOptions options)
type: scm:MotdBannerSetting
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 MotdBannerSettingArgs
- 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 MotdBannerSettingArgs
- 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 MotdBannerSettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MotdBannerSettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MotdBannerSettingArgs
- 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 motdBannerSettingResource = new Scm.MotdBannerSetting("motdBannerSettingResource", new()
{
Device = "string",
Folder = "string",
MotdAndBanner = new Scm.Inputs.MotdBannerSettingMotdAndBannerArgs
{
BannerFooter = "string",
BannerFooterColor = "string",
BannerFooterTextColor = "string",
BannerHeader = "string",
BannerHeaderColor = "string",
BannerHeaderFooterMatch = false,
BannerHeaderTextColor = "string",
Message = "string",
MotdColor = "string",
MotdDoNotDisplayAgain = false,
MotdEnable = false,
MotdTitle = "string",
Severity = "string",
},
Snippet = "string",
});
example, err := scm.NewMotdBannerSetting(ctx, "motdBannerSettingResource", &scm.MotdBannerSettingArgs{
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
MotdAndBanner: &scm.MotdBannerSettingMotdAndBannerArgs{
BannerFooter: pulumi.String("string"),
BannerFooterColor: pulumi.String("string"),
BannerFooterTextColor: pulumi.String("string"),
BannerHeader: pulumi.String("string"),
BannerHeaderColor: pulumi.String("string"),
BannerHeaderFooterMatch: pulumi.Bool(false),
BannerHeaderTextColor: pulumi.String("string"),
Message: pulumi.String("string"),
MotdColor: pulumi.String("string"),
MotdDoNotDisplayAgain: pulumi.Bool(false),
MotdEnable: pulumi.Bool(false),
MotdTitle: pulumi.String("string"),
Severity: pulumi.String("string"),
},
Snippet: pulumi.String("string"),
})
var motdBannerSettingResource = new MotdBannerSetting("motdBannerSettingResource", MotdBannerSettingArgs.builder()
.device("string")
.folder("string")
.motdAndBanner(MotdBannerSettingMotdAndBannerArgs.builder()
.bannerFooter("string")
.bannerFooterColor("string")
.bannerFooterTextColor("string")
.bannerHeader("string")
.bannerHeaderColor("string")
.bannerHeaderFooterMatch(false)
.bannerHeaderTextColor("string")
.message("string")
.motdColor("string")
.motdDoNotDisplayAgain(false)
.motdEnable(false)
.motdTitle("string")
.severity("string")
.build())
.snippet("string")
.build());
motd_banner_setting_resource = scm.MotdBannerSetting("motdBannerSettingResource",
device="string",
folder="string",
motd_and_banner={
"banner_footer": "string",
"banner_footer_color": "string",
"banner_footer_text_color": "string",
"banner_header": "string",
"banner_header_color": "string",
"banner_header_footer_match": False,
"banner_header_text_color": "string",
"message": "string",
"motd_color": "string",
"motd_do_not_display_again": False,
"motd_enable": False,
"motd_title": "string",
"severity": "string",
},
snippet="string")
const motdBannerSettingResource = new scm.MotdBannerSetting("motdBannerSettingResource", {
device: "string",
folder: "string",
motdAndBanner: {
bannerFooter: "string",
bannerFooterColor: "string",
bannerFooterTextColor: "string",
bannerHeader: "string",
bannerHeaderColor: "string",
bannerHeaderFooterMatch: false,
bannerHeaderTextColor: "string",
message: "string",
motdColor: "string",
motdDoNotDisplayAgain: false,
motdEnable: false,
motdTitle: "string",
severity: "string",
},
snippet: "string",
});
type: scm:MotdBannerSetting
properties:
device: string
folder: string
motdAndBanner:
bannerFooter: string
bannerFooterColor: string
bannerFooterTextColor: string
bannerHeader: string
bannerHeaderColor: string
bannerHeaderFooterMatch: false
bannerHeaderTextColor: string
message: string
motdColor: string
motdDoNotDisplayAgain: false
motdEnable: false
motdTitle: string
severity: string
snippet: string
MotdBannerSetting 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 MotdBannerSetting 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.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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.-
Motd
Banner Setting Motd And Banner Args - Motd and banner
- 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.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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.-
Motd
Banner Setting Motd And Banner Args - Motd and banner
- 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.- Property Map
- Motd and banner
- 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 MotdBannerSetting resource produces the following output properties:
Look up Existing MotdBannerSetting Resource
Get an existing MotdBannerSetting 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?: MotdBannerSettingState, opts?: CustomResourceOptions): MotdBannerSetting@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
motd_and_banner: Optional[MotdBannerSettingMotdAndBannerArgs] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> MotdBannerSettingfunc GetMotdBannerSetting(ctx *Context, name string, id IDInput, state *MotdBannerSettingState, opts ...ResourceOption) (*MotdBannerSetting, error)public static MotdBannerSetting Get(string name, Input<string> id, MotdBannerSettingState? state, CustomResourceOptions? opts = null)public static MotdBannerSetting get(String name, Output<String> id, MotdBannerSettingState state, CustomResourceOptions options)resources: _: type: scm:MotdBannerSetting 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
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.-
Motd
Banner Setting Motd And Banner Args - Motd and banner
- 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
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.-
Motd
Banner Setting Motd And Banner - Motd and banner
- 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
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.-
Motd
Banner Setting Motd And Banner Args - Motd and banner
- 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
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Property Map
- Motd and banner
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
Supporting Types
MotdBannerSettingMotdAndBanner, MotdBannerSettingMotdAndBannerArgs
- string
- Banner footer
- string
- The following list details the supported values and their colors.
- string
- The following list details the supported values and their colors.
- string
- Banner header
- string
- The following list details the supported values and their colors.
- bool
- Banner header footer match
- string
- The following list details the supported values and their colors.
- Message string
- Message
- Motd
Color string - The following list details the supported values and their colors.
- Motd
Do boolNot Display Again - Motd do not display again
- Motd
Enable bool - Motd enable
- Motd
Title string - Motd title
- Severity string
- Severity
- string
- Banner footer
- string
- The following list details the supported values and their colors.
- string
- The following list details the supported values and their colors.
- string
- Banner header
- string
- The following list details the supported values and their colors.
- bool
- Banner header footer match
- string
- The following list details the supported values and their colors.
- Message string
- Message
- Motd
Color string - The following list details the supported values and their colors.
- Motd
Do boolNot Display Again - Motd do not display again
- Motd
Enable bool - Motd enable
- Motd
Title string - Motd title
- Severity string
- Severity
- String
- Banner footer
- String
- The following list details the supported values and their colors.
- String
- The following list details the supported values and their colors.
- String
- Banner header
- String
- The following list details the supported values and their colors.
- Boolean
- Banner header footer match
- String
- The following list details the supported values and their colors.
- message String
- Message
- motd
Color String - The following list details the supported values and their colors.
- motd
Do BooleanNot Display Again - Motd do not display again
- motd
Enable Boolean - Motd enable
- motd
Title String - Motd title
- severity String
- Severity
- string
- Banner footer
- string
- The following list details the supported values and their colors.
- string
- The following list details the supported values and their colors.
- string
- Banner header
- string
- The following list details the supported values and their colors.
- boolean
- Banner header footer match
- string
- The following list details the supported values and their colors.
- message string
- Message
- motd
Color string - The following list details the supported values and their colors.
- motd
Do booleanNot Display Again - Motd do not display again
- motd
Enable boolean - Motd enable
- motd
Title string - Motd title
- severity string
- Severity
- str
- Banner footer
- str
- The following list details the supported values and their colors.
- str
- The following list details the supported values and their colors.
- str
- Banner header
- str
- The following list details the supported values and their colors.
- bool
- Banner header footer match
- str
- The following list details the supported values and their colors.
- message str
- Message
- motd_
color str - The following list details the supported values and their colors.
- motd_
do_ boolnot_ display_ again - Motd do not display again
- motd_
enable bool - Motd enable
- motd_
title str - Motd title
- severity str
- Severity
- String
- Banner footer
- String
- The following list details the supported values and their colors.
- String
- The following list details the supported values and their colors.
- String
- Banner header
- String
- The following list details the supported values and their colors.
- Boolean
- Banner header footer match
- String
- The following list details the supported values and their colors.
- message String
- Message
- motd
Color String - The following list details the supported values and their colors.
- motd
Do BooleanNot Display Again - Motd do not display again
- motd
Enable Boolean - Motd enable
- motd
Title String - Motd title
- severity String
- Severity
Import
The following command can be used to import a resource not managed by Terraform:
bash
$ pulumi import scm:index/motdBannerSetting:MotdBannerSetting example folder:::id
or
bash
$ pulumi import scm:index/motdBannerSetting:MotdBannerSetting example :snippet::id
or
bash
$ pulumi import scm:index/motdBannerSetting:MotdBannerSetting 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.
