GeneralSetting resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const gsExample = new scm.GeneralSetting("gs_example", {
folder: "All",
general: {
domain: "foo.com",
loginBanner: "Test Banner",
ackLoginBanner: false,
locale: "en",
geoLocation: {
latitude: "37.38314",
longitude: "-121.98306",
},
timezone: "America/Los_Angeles",
setting: {
management: {
autoAcquireCommitLock: true,
enableCertificateExpirationCheck: false,
},
autoMacDetect: false,
tunnelAcceleration: true,
failOpen: false,
},
},
});
import pulumi
import pulumi_scm as scm
gs_example = scm.GeneralSetting("gs_example",
folder="All",
general={
"domain": "foo.com",
"login_banner": "Test Banner",
"ack_login_banner": False,
"locale": "en",
"geo_location": {
"latitude": "37.38314",
"longitude": "-121.98306",
},
"timezone": "America/Los_Angeles",
"setting": {
"management": {
"auto_acquire_commit_lock": True,
"enable_certificate_expiration_check": False,
},
"auto_mac_detect": False,
"tunnel_acceleration": True,
"fail_open": False,
},
})
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.NewGeneralSetting(ctx, "gs_example", &scm.GeneralSettingArgs{
Folder: pulumi.String("All"),
General: &scm.GeneralSettingGeneralArgs{
Domain: pulumi.String("foo.com"),
LoginBanner: pulumi.String("Test Banner"),
AckLoginBanner: pulumi.Bool(false),
Locale: pulumi.String("en"),
GeoLocation: &scm.GeneralSettingGeneralGeoLocationArgs{
Latitude: pulumi.String("37.38314"),
Longitude: pulumi.String("-121.98306"),
},
Timezone: pulumi.String("America/Los_Angeles"),
Setting: &scm.GeneralSettingGeneralSettingArgs{
Management: &scm.GeneralSettingGeneralSettingManagementArgs{
AutoAcquireCommitLock: pulumi.Bool(true),
EnableCertificateExpirationCheck: pulumi.Bool(false),
},
AutoMacDetect: pulumi.Bool(false),
TunnelAcceleration: pulumi.Bool(true),
FailOpen: pulumi.Bool(false),
},
},
})
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 gsExample = new Scm.GeneralSetting("gs_example", new()
{
Folder = "All",
General = new Scm.Inputs.GeneralSettingGeneralArgs
{
Domain = "foo.com",
LoginBanner = "Test Banner",
AckLoginBanner = false,
Locale = "en",
GeoLocation = new Scm.Inputs.GeneralSettingGeneralGeoLocationArgs
{
Latitude = "37.38314",
Longitude = "-121.98306",
},
Timezone = "America/Los_Angeles",
Setting = new Scm.Inputs.GeneralSettingGeneralSettingArgs
{
Management = new Scm.Inputs.GeneralSettingGeneralSettingManagementArgs
{
AutoAcquireCommitLock = true,
EnableCertificateExpirationCheck = false,
},
AutoMacDetect = false,
TunnelAcceleration = true,
FailOpen = false,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.GeneralSetting;
import com.pulumi.scm.GeneralSettingArgs;
import com.pulumi.scm.inputs.GeneralSettingGeneralArgs;
import com.pulumi.scm.inputs.GeneralSettingGeneralGeoLocationArgs;
import com.pulumi.scm.inputs.GeneralSettingGeneralSettingArgs;
import com.pulumi.scm.inputs.GeneralSettingGeneralSettingManagementArgs;
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 gsExample = new GeneralSetting("gsExample", GeneralSettingArgs.builder()
.folder("All")
.general(GeneralSettingGeneralArgs.builder()
.domain("foo.com")
.loginBanner("Test Banner")
.ackLoginBanner(false)
.locale("en")
.geoLocation(GeneralSettingGeneralGeoLocationArgs.builder()
.latitude("37.38314")
.longitude("-121.98306")
.build())
.timezone("America/Los_Angeles")
.setting(GeneralSettingGeneralSettingArgs.builder()
.management(GeneralSettingGeneralSettingManagementArgs.builder()
.autoAcquireCommitLock(true)
.enableCertificateExpirationCheck(false)
.build())
.autoMacDetect(false)
.tunnelAcceleration(true)
.failOpen(false)
.build())
.build())
.build());
}
}
resources:
gsExample:
type: scm:GeneralSetting
name: gs_example
properties:
folder: All
general:
domain: foo.com
loginBanner: Test Banner
ackLoginBanner: false
locale: en
geoLocation:
latitude: '37.38314'
longitude: '-121.98306'
timezone: America/Los_Angeles
setting:
management:
autoAcquireCommitLock: true
enableCertificateExpirationCheck: false
autoMacDetect: false
tunnelAcceleration: true
failOpen: false
Create GeneralSetting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GeneralSetting(name: string, args?: GeneralSettingArgs, opts?: CustomResourceOptions);@overload
def GeneralSetting(resource_name: str,
args: Optional[GeneralSettingArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GeneralSetting(resource_name: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
general: Optional[GeneralSettingGeneralArgs] = None,
snippet: Optional[str] = None)func NewGeneralSetting(ctx *Context, name string, args *GeneralSettingArgs, opts ...ResourceOption) (*GeneralSetting, error)public GeneralSetting(string name, GeneralSettingArgs? args = null, CustomResourceOptions? opts = null)
public GeneralSetting(String name, GeneralSettingArgs args)
public GeneralSetting(String name, GeneralSettingArgs args, CustomResourceOptions options)
type: scm:GeneralSetting
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 GeneralSettingArgs
- 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 GeneralSettingArgs
- 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 GeneralSettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GeneralSettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GeneralSettingArgs
- 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 generalSettingResource = new Scm.GeneralSetting("generalSettingResource", new()
{
Device = "string",
Folder = "string",
General = new Scm.Inputs.GeneralSettingGeneralArgs
{
AckLoginBanner = false,
Domain = "string",
GeoLocation = new Scm.Inputs.GeneralSettingGeneralGeoLocationArgs
{
Latitude = "string",
Longitude = "string",
},
Locale = "string",
LoginBanner = "string",
Setting = new Scm.Inputs.GeneralSettingGeneralSettingArgs
{
AutoMacDetect = false,
FailOpen = false,
Management = new Scm.Inputs.GeneralSettingGeneralSettingManagementArgs
{
AutoAcquireCommitLock = false,
EnableCertificateExpirationCheck = false,
},
TunnelAcceleration = false,
},
SslTlsServiceProfile = "string",
Timezone = "string",
},
Snippet = "string",
});
example, err := scm.NewGeneralSetting(ctx, "generalSettingResource", &scm.GeneralSettingArgs{
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
General: &scm.GeneralSettingGeneralArgs{
AckLoginBanner: pulumi.Bool(false),
Domain: pulumi.String("string"),
GeoLocation: &scm.GeneralSettingGeneralGeoLocationArgs{
Latitude: pulumi.String("string"),
Longitude: pulumi.String("string"),
},
Locale: pulumi.String("string"),
LoginBanner: pulumi.String("string"),
Setting: &scm.GeneralSettingGeneralSettingArgs{
AutoMacDetect: pulumi.Bool(false),
FailOpen: pulumi.Bool(false),
Management: &scm.GeneralSettingGeneralSettingManagementArgs{
AutoAcquireCommitLock: pulumi.Bool(false),
EnableCertificateExpirationCheck: pulumi.Bool(false),
},
TunnelAcceleration: pulumi.Bool(false),
},
SslTlsServiceProfile: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
Snippet: pulumi.String("string"),
})
var generalSettingResource = new GeneralSetting("generalSettingResource", GeneralSettingArgs.builder()
.device("string")
.folder("string")
.general(GeneralSettingGeneralArgs.builder()
.ackLoginBanner(false)
.domain("string")
.geoLocation(GeneralSettingGeneralGeoLocationArgs.builder()
.latitude("string")
.longitude("string")
.build())
.locale("string")
.loginBanner("string")
.setting(GeneralSettingGeneralSettingArgs.builder()
.autoMacDetect(false)
.failOpen(false)
.management(GeneralSettingGeneralSettingManagementArgs.builder()
.autoAcquireCommitLock(false)
.enableCertificateExpirationCheck(false)
.build())
.tunnelAcceleration(false)
.build())
.sslTlsServiceProfile("string")
.timezone("string")
.build())
.snippet("string")
.build());
general_setting_resource = scm.GeneralSetting("generalSettingResource",
device="string",
folder="string",
general={
"ack_login_banner": False,
"domain": "string",
"geo_location": {
"latitude": "string",
"longitude": "string",
},
"locale": "string",
"login_banner": "string",
"setting": {
"auto_mac_detect": False,
"fail_open": False,
"management": {
"auto_acquire_commit_lock": False,
"enable_certificate_expiration_check": False,
},
"tunnel_acceleration": False,
},
"ssl_tls_service_profile": "string",
"timezone": "string",
},
snippet="string")
const generalSettingResource = new scm.GeneralSetting("generalSettingResource", {
device: "string",
folder: "string",
general: {
ackLoginBanner: false,
domain: "string",
geoLocation: {
latitude: "string",
longitude: "string",
},
locale: "string",
loginBanner: "string",
setting: {
autoMacDetect: false,
failOpen: false,
management: {
autoAcquireCommitLock: false,
enableCertificateExpirationCheck: false,
},
tunnelAcceleration: false,
},
sslTlsServiceProfile: "string",
timezone: "string",
},
snippet: "string",
});
type: scm:GeneralSetting
properties:
device: string
folder: string
general:
ackLoginBanner: false
domain: string
geoLocation:
latitude: string
longitude: string
locale: string
loginBanner: string
setting:
autoMacDetect: false
failOpen: false
management:
autoAcquireCommitLock: false
enableCertificateExpirationCheck: false
tunnelAcceleration: false
sslTlsServiceProfile: string
timezone: string
snippet: string
GeneralSetting 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 GeneralSetting 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.- General
General
Setting General - General
- 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.- General
General
Setting General Args - General
- 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.- general
General
Setting General - General
- 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.- general
General
Setting General - General
- 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.- general
General
Setting General Args - General
- 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.- general Property Map
- General
- 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 GeneralSetting resource produces the following output properties:
Look up Existing GeneralSetting Resource
Get an existing GeneralSetting 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?: GeneralSettingState, opts?: CustomResourceOptions): GeneralSetting@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
general: Optional[GeneralSettingGeneralArgs] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> GeneralSettingfunc GetGeneralSetting(ctx *Context, name string, id IDInput, state *GeneralSettingState, opts ...ResourceOption) (*GeneralSetting, error)public static GeneralSetting Get(string name, Input<string> id, GeneralSettingState? state, CustomResourceOptions? opts = null)public static GeneralSetting get(String name, Output<String> id, GeneralSettingState state, CustomResourceOptions options)resources: _: type: scm:GeneralSetting 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.- General
General
Setting General - General
- 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.- General
General
Setting General Args - General
- 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.- general
General
Setting General - General
- 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.- general
General
Setting General - General
- 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.- general
General
Setting General Args - General
- 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.- general Property Map
- General
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
Supporting Types
GeneralSettingGeneral, GeneralSettingGeneralArgs
- bool
- Force admins to acknowledge login banner
- Domain string
- DNS domain
- Geo
Location GeneralSetting General Geo Location - Geographic coordinates
- Locale string
- Locale
- string
- Logon banner
- Setting
General
Setting General Setting - Setting
- Ssl
Tls stringService Profile - SSL/TLS service profile
- Timezone string
- Timezone
- bool
- Force admins to acknowledge login banner
- Domain string
- DNS domain
- Geo
Location GeneralSetting General Geo Location - Geographic coordinates
- Locale string
- Locale
- string
- Logon banner
- Setting
General
Setting General Setting - Setting
- Ssl
Tls stringService Profile - SSL/TLS service profile
- Timezone string
- Timezone
- Boolean
- Force admins to acknowledge login banner
- domain String
- DNS domain
- geo
Location GeneralSetting General Geo Location - Geographic coordinates
- locale String
- Locale
- String
- Logon banner
- setting
General
Setting General Setting - Setting
- ssl
Tls StringService Profile - SSL/TLS service profile
- timezone String
- Timezone
- boolean
- Force admins to acknowledge login banner
- domain string
- DNS domain
- geo
Location GeneralSetting General Geo Location - Geographic coordinates
- locale string
- Locale
- string
- Logon banner
- setting
General
Setting General Setting - Setting
- ssl
Tls stringService Profile - SSL/TLS service profile
- timezone string
- Timezone
- bool
- Force admins to acknowledge login banner
- domain str
- DNS domain
- geo_
location GeneralSetting General Geo Location - Geographic coordinates
- locale str
- Locale
- str
- Logon banner
- setting
General
Setting General Setting - Setting
- ssl_
tls_ strservice_ profile - SSL/TLS service profile
- timezone str
- Timezone
- Boolean
- Force admins to acknowledge login banner
- domain String
- DNS domain
- geo
Location Property Map - Geographic coordinates
- locale String
- Locale
- String
- Logon banner
- setting Property Map
- Setting
- ssl
Tls StringService Profile - SSL/TLS service profile
- timezone String
- Timezone
GeneralSettingGeneralGeoLocation, GeneralSettingGeneralGeoLocationArgs
GeneralSettingGeneralSetting, GeneralSettingGeneralSettingArgs
- Auto
Mac boolDetect - Use hypervisor assigned MAC addresses
- Fail
Open bool - Fail open
- Management
General
Setting General Setting Management - Management
- Tunnel
Acceleration bool - Tunnel acceleration
- Auto
Mac boolDetect - Use hypervisor assigned MAC addresses
- Fail
Open bool - Fail open
- Management
General
Setting General Setting Management - Management
- Tunnel
Acceleration bool - Tunnel acceleration
- auto
Mac BooleanDetect - Use hypervisor assigned MAC addresses
- fail
Open Boolean - Fail open
- management
General
Setting General Setting Management - Management
- tunnel
Acceleration Boolean - Tunnel acceleration
- auto
Mac booleanDetect - Use hypervisor assigned MAC addresses
- fail
Open boolean - Fail open
- management
General
Setting General Setting Management - Management
- tunnel
Acceleration boolean - Tunnel acceleration
- auto_
mac_ booldetect - Use hypervisor assigned MAC addresses
- fail_
open bool - Fail open
- management
General
Setting General Setting Management - Management
- tunnel_
acceleration bool - Tunnel acceleration
- auto
Mac BooleanDetect - Use hypervisor assigned MAC addresses
- fail
Open Boolean - Fail open
- management Property Map
- Management
- tunnel
Acceleration Boolean - Tunnel acceleration
GeneralSettingGeneralSettingManagement, GeneralSettingGeneralSettingManagementArgs
- Auto
Acquire boolCommit Lock - Automatically acquire commit lock
- Enable
Certificate boolExpiration Check - Certificate expiration check
- Auto
Acquire boolCommit Lock - Automatically acquire commit lock
- Enable
Certificate boolExpiration Check - Certificate expiration check
- auto
Acquire BooleanCommit Lock - Automatically acquire commit lock
- enable
Certificate BooleanExpiration Check - Certificate expiration check
- auto
Acquire booleanCommit Lock - Automatically acquire commit lock
- enable
Certificate booleanExpiration Check - Certificate expiration check
- auto_
acquire_ boolcommit_ lock - Automatically acquire commit lock
- enable_
certificate_ boolexpiration_ check - Certificate expiration check
- auto
Acquire BooleanCommit Lock - Automatically acquire commit lock
- enable
Certificate BooleanExpiration Check - Certificate expiration check
Import
The following command can be used to import a resource not managed by Terraform:
bash
$ pulumi import scm:index/generalSetting:GeneralSetting example folder:::id
or
bash
$ pulumi import scm:index/generalSetting:GeneralSetting example :snippet::id
or
bash
$ pulumi import scm:index/generalSetting:GeneralSetting 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.
