netlify 0.2.2, Mar 7 25

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify.SiteCollaborationSettings

Explore with Pulumi AI

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as netlify from "@pulumi/netlify";

const blog = new netlify.SiteCollaborationSettings("blog", {
    siteId: data.netlify_site.blog.id,
    netlifyDrawerInDeployPreviews: true,
    netlifyDrawerInBranchDeploys: true,
    netlifyHeadsUpDisplay: true,
});

import pulumi
import pulumi_netlify as netlify

blog = netlify.SiteCollaborationSettings("blog",
    site_id=data["netlify_site"]["blog"]["id"],
    netlify_drawer_in_deploy_previews=True,
    netlify_drawer_in_branch_deploys=True,
    netlify_heads_up_display=True)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netlify/netlify"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netlify.NewSiteCollaborationSettings(ctx, "blog", &netlify.SiteCollaborationSettingsArgs{
			SiteId:                        pulumi.Any(data.Netlify_site.Blog.Id),
			NetlifyDrawerInDeployPreviews: pulumi.Bool(true),
			NetlifyDrawerInBranchDeploys:  pulumi.Bool(true),
			NetlifyHeadsUpDisplay:         pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netlify = Pulumi.Netlify;

return await Deployment.RunAsync(() => 
{
    var blog = new Netlify.SiteCollaborationSettings("blog", new()
    {
        SiteId = data.Netlify_site.Blog.Id,
        NetlifyDrawerInDeployPreviews = true,
        NetlifyDrawerInBranchDeploys = true,
        NetlifyHeadsUpDisplay = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netlify.SiteCollaborationSettings;
import com.pulumi.netlify.SiteCollaborationSettingsArgs;
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 blog = new SiteCollaborationSettings("blog", SiteCollaborationSettingsArgs.builder()
            .siteId(data.netlify_site().blog().id())
            .netlifyDrawerInDeployPreviews(true)
            .netlifyDrawerInBranchDeploys(true)
            .netlifyHeadsUpDisplay(true)
            .build());

    }
}

resources:
  blog:
    type: netlify:SiteCollaborationSettings
    properties:
      siteId: ${data.netlify_site.blog.id}
      netlifyDrawerInDeployPreviews: true
      netlifyDrawerInBranchDeploys: true
      netlifyHeadsUpDisplay: true

Create SiteCollaborationSettings Resource

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

new SiteCollaborationSettings(name: string, args: SiteCollaborationSettingsArgs, opts?: CustomResourceOptions);

@overload
def SiteCollaborationSettings(resource_name: str,
                              args: SiteCollaborationSettingsArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def SiteCollaborationSettings(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              netlify_drawer_in_branch_deploys: Optional[bool] = None,
                              netlify_drawer_in_deploy_previews: Optional[bool] = None,
                              netlify_heads_up_display: Optional[bool] = None,
                              site_id: Optional[str] = None)

func NewSiteCollaborationSettings(ctx *Context, name string, args SiteCollaborationSettingsArgs, opts ...ResourceOption) (*SiteCollaborationSettings, error)

public SiteCollaborationSettings(string name, SiteCollaborationSettingsArgs args, CustomResourceOptions? opts = null)

public SiteCollaborationSettings(String name, SiteCollaborationSettingsArgs args)
public SiteCollaborationSettings(String name, SiteCollaborationSettingsArgs args, CustomResourceOptions options)

type: netlify:SiteCollaborationSettings
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 SiteCollaborationSettingsArgs: 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 SiteCollaborationSettingsArgs: 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 SiteCollaborationSettingsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SiteCollaborationSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SiteCollaborationSettingsArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var siteCollaborationSettingsResource = new Netlify.SiteCollaborationSettings("siteCollaborationSettingsResource", new()
{
    NetlifyDrawerInBranchDeploys = false,
    NetlifyDrawerInDeployPreviews = false,
    NetlifyHeadsUpDisplay = false,
    SiteId = "string",
});

example, err := netlify.NewSiteCollaborationSettings(ctx, "siteCollaborationSettingsResource", &netlify.SiteCollaborationSettingsArgs{
NetlifyDrawerInBranchDeploys: pulumi.Bool(false),
NetlifyDrawerInDeployPreviews: pulumi.Bool(false),
NetlifyHeadsUpDisplay: pulumi.Bool(false),
SiteId: pulumi.String("string"),
})

var siteCollaborationSettingsResource = new SiteCollaborationSettings("siteCollaborationSettingsResource", SiteCollaborationSettingsArgs.builder()
    .netlifyDrawerInBranchDeploys(false)
    .netlifyDrawerInDeployPreviews(false)
    .netlifyHeadsUpDisplay(false)
    .siteId("string")
    .build());

site_collaboration_settings_resource = netlify.SiteCollaborationSettings("siteCollaborationSettingsResource",
    netlify_drawer_in_branch_deploys=False,
    netlify_drawer_in_deploy_previews=False,
    netlify_heads_up_display=False,
    site_id="string")

const siteCollaborationSettingsResource = new netlify.SiteCollaborationSettings("siteCollaborationSettingsResource", {
    netlifyDrawerInBranchDeploys: false,
    netlifyDrawerInDeployPreviews: false,
    netlifyHeadsUpDisplay: false,
    siteId: "string",
});

type: netlify:SiteCollaborationSettings
properties:
    netlifyDrawerInBranchDeploys: false
    netlifyDrawerInDeployPreviews: false
    netlifyHeadsUpDisplay: false
    siteId: string

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

NetlifyDrawerInBranchDeploys bool
NetlifyDrawerInDeployPreviews bool
NetlifyHeadsUpDisplay bool
SiteId string

NetlifyDrawerInBranchDeploys bool
NetlifyDrawerInDeployPreviews bool
NetlifyHeadsUpDisplay bool
SiteId string

netlifyDrawerInBranchDeploys Boolean
netlifyDrawerInDeployPreviews Boolean
netlifyHeadsUpDisplay Boolean
siteId String

netlifyDrawerInBranchDeploys boolean
netlifyDrawerInDeployPreviews boolean
netlifyHeadsUpDisplay boolean
siteId string

netlify_drawer_in_branch_deploys bool
netlify_drawer_in_deploy_previews bool
netlify_heads_up_display bool
site_id str

netlifyDrawerInBranchDeploys Boolean
netlifyDrawerInDeployPreviews Boolean
netlifyHeadsUpDisplay Boolean
siteId String

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
LastUpdated string

Id string: The provider-assigned unique ID for this managed resource.
LastUpdated string

id String: The provider-assigned unique ID for this managed resource.
lastUpdated String

id string: The provider-assigned unique ID for this managed resource.
lastUpdated string

id str: The provider-assigned unique ID for this managed resource.
last_updated str

id String: The provider-assigned unique ID for this managed resource.
lastUpdated String

Look up Existing SiteCollaborationSettings Resource

Get an existing SiteCollaborationSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: SiteCollaborationSettingsState, opts?: CustomResourceOptions): SiteCollaborationSettings

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        last_updated: Optional[str] = None,
        netlify_drawer_in_branch_deploys: Optional[bool] = None,
        netlify_drawer_in_deploy_previews: Optional[bool] = None,
        netlify_heads_up_display: Optional[bool] = None,
        site_id: Optional[str] = None) -> SiteCollaborationSettings

func GetSiteCollaborationSettings(ctx *Context, name string, id IDInput, state *SiteCollaborationSettingsState, opts ...ResourceOption) (*SiteCollaborationSettings, error)

public static SiteCollaborationSettings Get(string name, Input<string> id, SiteCollaborationSettingsState? state, CustomResourceOptions? opts = null)

public static SiteCollaborationSettings get(String name, Output<String> id, SiteCollaborationSettingsState state, CustomResourceOptions options)

resources:  _:    type: netlify:SiteCollaborationSettings    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.

The following state arguments are supported:

LastUpdated string
NetlifyDrawerInBranchDeploys bool
NetlifyDrawerInDeployPreviews bool
NetlifyHeadsUpDisplay bool
SiteId string

LastUpdated string
NetlifyDrawerInBranchDeploys bool
NetlifyDrawerInDeployPreviews bool
NetlifyHeadsUpDisplay bool
SiteId string

lastUpdated String
netlifyDrawerInBranchDeploys Boolean
netlifyDrawerInDeployPreviews Boolean
netlifyHeadsUpDisplay Boolean
siteId String

lastUpdated string
netlifyDrawerInBranchDeploys boolean
netlifyDrawerInDeployPreviews boolean
netlifyHeadsUpDisplay boolean
siteId string

last_updated str
netlify_drawer_in_branch_deploys bool
netlify_drawer_in_deploy_previews bool
netlify_heads_up_display bool
site_id str

lastUpdated String
netlifyDrawerInBranchDeploys Boolean
netlifyDrawerInDeployPreviews Boolean
netlifyHeadsUpDisplay Boolean
siteId String

Import

Import a site’s collaboration settings by the site ID

$ pulumi import netlify:index/siteCollaborationSettings:SiteCollaborationSettings blog 12345667-0000-0000-0000-abcdef012345

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

Package Details

Repository: netlify netlify/terraform-provider-netlify
License
Notes: This Pulumi package is based on the netlify Terraform Provider.

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify/terraform-provider-netlify

netlify.SiteCollaborationSettings

On this page

On this page

Example Usage

Create SiteCollaborationSettings Resource

Constructor syntax

Parameters

Constructor example

SiteCollaborationSettings Resource Properties

Inputs

Outputs

Look up Existing SiteCollaborationSettings Resource

Import

Package Details

On this page

On this page