1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. CloudBrowserIsolationBanner
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

zpa.CloudBrowserIsolationBanner

Explore with Pulumi AI

The zpa_cloud_browser_isolation_banner resource creates a Cloud Browser Isolation banner. This resource is required as part of the attribute banner_id when creating an Cloud Browser Isolation External Profile zpa.CloudBrowserIsolationExternalProfile

Create CloudBrowserIsolationBanner Resource

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

Constructor syntax

new CloudBrowserIsolationBanner(name: string, args?: CloudBrowserIsolationBannerArgs, opts?: CustomResourceOptions);
@overload
def CloudBrowserIsolationBanner(resource_name: str,
                                args: Optional[CloudBrowserIsolationBannerArgs] = None,
                                opts: Optional[ResourceOptions] = None)

@overload
def CloudBrowserIsolationBanner(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                banner: Optional[bool] = None,
                                logo: Optional[str] = None,
                                name: Optional[str] = None,
                                notification_text: Optional[str] = None,
                                notification_title: Optional[str] = None,
                                persist: Optional[bool] = None,
                                primary_color: Optional[str] = None,
                                text_color: Optional[str] = None)
func NewCloudBrowserIsolationBanner(ctx *Context, name string, args *CloudBrowserIsolationBannerArgs, opts ...ResourceOption) (*CloudBrowserIsolationBanner, error)
public CloudBrowserIsolationBanner(string name, CloudBrowserIsolationBannerArgs? args = null, CustomResourceOptions? opts = null)
public CloudBrowserIsolationBanner(String name, CloudBrowserIsolationBannerArgs args)
public CloudBrowserIsolationBanner(String name, CloudBrowserIsolationBannerArgs args, CustomResourceOptions options)
type: zpa:CloudBrowserIsolationBanner
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args CloudBrowserIsolationBannerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args CloudBrowserIsolationBannerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args CloudBrowserIsolationBannerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args CloudBrowserIsolationBannerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CloudBrowserIsolationBannerArgs
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 cloudBrowserIsolationBannerResource = new Zpa.CloudBrowserIsolationBanner("cloudBrowserIsolationBannerResource", new()
{
    Banner = false,
    Logo = "string",
    Name = "string",
    NotificationText = "string",
    NotificationTitle = "string",
    Persist = false,
    PrimaryColor = "string",
    TextColor = "string",
});
Copy
example, err := zpa.NewCloudBrowserIsolationBanner(ctx, "cloudBrowserIsolationBannerResource", &zpa.CloudBrowserIsolationBannerArgs{
	Banner:            pulumi.Bool(false),
	Logo:              pulumi.String("string"),
	Name:              pulumi.String("string"),
	NotificationText:  pulumi.String("string"),
	NotificationTitle: pulumi.String("string"),
	Persist:           pulumi.Bool(false),
	PrimaryColor:      pulumi.String("string"),
	TextColor:         pulumi.String("string"),
})
Copy
var cloudBrowserIsolationBannerResource = new CloudBrowserIsolationBanner("cloudBrowserIsolationBannerResource", CloudBrowserIsolationBannerArgs.builder()
    .banner(false)
    .logo("string")
    .name("string")
    .notificationText("string")
    .notificationTitle("string")
    .persist(false)
    .primaryColor("string")
    .textColor("string")
    .build());
Copy
cloud_browser_isolation_banner_resource = zpa.CloudBrowserIsolationBanner("cloudBrowserIsolationBannerResource",
    banner=False,
    logo="string",
    name="string",
    notification_text="string",
    notification_title="string",
    persist=False,
    primary_color="string",
    text_color="string")
Copy
const cloudBrowserIsolationBannerResource = new zpa.CloudBrowserIsolationBanner("cloudBrowserIsolationBannerResource", {
    banner: false,
    logo: "string",
    name: "string",
    notificationText: "string",
    notificationTitle: "string",
    persist: false,
    primaryColor: "string",
    textColor: "string",
});
Copy
type: zpa:CloudBrowserIsolationBanner
properties:
    banner: false
    logo: string
    name: string
    notificationText: string
    notificationTitle: string
    persist: false
    primaryColor: string
    textColor: string
Copy

CloudBrowserIsolationBanner 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 CloudBrowserIsolationBanner resource accepts the following input properties:

bool
Logo string
Name string
NotificationText string
NotificationTitle string
Persist bool
PrimaryColor string
TextColor string
bool
Logo string
Name string
NotificationText string
NotificationTitle string
Persist bool
PrimaryColor string
TextColor string
Boolean
logo String
name String
notificationText String
notificationTitle String
persist Boolean
primaryColor String
textColor String
boolean
logo string
name string
notificationText string
notificationTitle string
persist boolean
primaryColor string
textColor string
Boolean
logo String
name String
notificationText String
notificationTitle String
persist Boolean
primaryColor String
textColor String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing CloudBrowserIsolationBanner Resource

Get an existing CloudBrowserIsolationBanner 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?: CloudBrowserIsolationBannerState, opts?: CustomResourceOptions): CloudBrowserIsolationBanner
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        banner: Optional[bool] = None,
        logo: Optional[str] = None,
        name: Optional[str] = None,
        notification_text: Optional[str] = None,
        notification_title: Optional[str] = None,
        persist: Optional[bool] = None,
        primary_color: Optional[str] = None,
        text_color: Optional[str] = None) -> CloudBrowserIsolationBanner
func GetCloudBrowserIsolationBanner(ctx *Context, name string, id IDInput, state *CloudBrowserIsolationBannerState, opts ...ResourceOption) (*CloudBrowserIsolationBanner, error)
public static CloudBrowserIsolationBanner Get(string name, Input<string> id, CloudBrowserIsolationBannerState? state, CustomResourceOptions? opts = null)
public static CloudBrowserIsolationBanner get(String name, Output<String> id, CloudBrowserIsolationBannerState state, CustomResourceOptions options)
resources:  _:    type: zpa:CloudBrowserIsolationBanner    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Banner bool
Logo string
Name string
NotificationText string
NotificationTitle string
Persist bool
PrimaryColor string
TextColor string
Banner bool
Logo string
Name string
NotificationText string
NotificationTitle string
Persist bool
PrimaryColor string
TextColor string
banner Boolean
logo String
name String
notificationText String
notificationTitle String
persist Boolean
primaryColor String
textColor String
banner boolean
logo string
name string
notificationText string
notificationTitle string
persist boolean
primaryColor string
textColor string
banner Boolean
logo String
name String
notificationText String
notificationTitle String
persist Boolean
primaryColor String
textColor String

Import

Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.

Visit

Application Segment can be imported by using <BANNER ID> or <BANNER NAME> as the import ID.

$ pulumi import zpa:index/cloudBrowserIsolationBanner:CloudBrowserIsolationBanner example <banner_id>
Copy

or

$ pulumi import zpa:index/cloudBrowserIsolationBanner:CloudBrowserIsolationBanner example <banner_name>
Copy

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

Package Details

Repository
zpa zscaler/pulumi-zpa
License
MIT
Notes
This Pulumi package is based on the zpa Terraform Provider.