1. Packages
  2. Buildkite
  3. API Docs
  4. Organization
  5. Banner
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse

buildkite.Organization.Banner

Explore with Pulumi AI

buildkite logo
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse

    This resource allows you to create and manage banners for specific organizations, displayed to all members at the top of each page in Buildkite’s UI.

    More information on organization/system banners can be found in the documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as buildkite from "@pulumiverse/buildkite";
    
    const banner = new buildkite.organization.Banner("banner", {message: ":warning: Please be aware of the maintenance window this weekend!"});
    
    import pulumi
    import pulumiverse_buildkite as buildkite
    
    banner = buildkite.organization.Banner("banner", message=":warning: Please be aware of the maintenance window this weekend!")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/Organization"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Organization.NewBanner(ctx, "banner", &Organization.BannerArgs{
    			Message: pulumi.String(":warning: Please be aware of the maintenance window this weekend!"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Buildkite = Pulumiverse.Buildkite;
    
    return await Deployment.RunAsync(() => 
    {
        var banner = new Buildkite.Organization.Banner("banner", new()
        {
            Message = ":warning: Please be aware of the maintenance window this weekend!",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.buildkite.Organization.Banner;
    import com.pulumi.buildkite.Organization.BannerArgs;
    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 banner = new Banner("banner", BannerArgs.builder()        
                .message(":warning: Please be aware of the maintenance window this weekend!")
                .build());
    
        }
    }
    
    resources:
      banner:
        type: buildkite:Organization:Banner
        properties:
          message: ':warning: Please be aware of the maintenance window this weekend!'
    

    Create Banner Resource

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

    Constructor syntax

    new Banner(name: string, args: BannerArgs, opts?: CustomResourceOptions);
    @overload
    def Banner(resource_name: str,
               args: BannerArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Banner(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               message: Optional[str] = None)
    func NewBanner(ctx *Context, name string, args BannerArgs, opts ...ResourceOption) (*Banner, error)
    public Banner(string name, BannerArgs args, CustomResourceOptions? opts = null)
    public Banner(String name, BannerArgs args)
    public Banner(String name, BannerArgs args, CustomResourceOptions options)
    
    type: buildkite:Organization:Banner
    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 BannerArgs
    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 BannerArgs
    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 BannerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var bannerResource = new Buildkite.Organization.Banner("bannerResource", new()
    {
        Message = "string",
    });
    
    example, err := Organization.NewBanner(ctx, "bannerResource", &Organization.BannerArgs{
    	Message: pulumi.String("string"),
    })
    
    var bannerResource = new Banner("bannerResource", BannerArgs.builder()        
        .message("string")
        .build());
    
    banner_resource = buildkite.organization.Banner("bannerResource", message="string")
    
    const bannerResource = new buildkite.organization.Banner("bannerResource", {message: "string"});
    
    type: buildkite:Organization:Banner
    properties:
        message: string
    

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

    Message string
    The organization banner's message.
    Message string
    The organization banner's message.
    message String
    The organization banner's message.
    message string
    The organization banner's message.
    message str
    The organization banner's message.
    message String
    The organization banner's message.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the organization banner.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the organization banner.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the organization banner.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    The UUID of the organization banner.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    The UUID of the organization banner.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the organization banner.

    Look up Existing Banner Resource

    Get an existing Banner 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?: BannerState, opts?: CustomResourceOptions): Banner
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            message: Optional[str] = None,
            uuid: Optional[str] = None) -> Banner
    func GetBanner(ctx *Context, name string, id IDInput, state *BannerState, opts ...ResourceOption) (*Banner, error)
    public static Banner Get(string name, Input<string> id, BannerState? state, CustomResourceOptions? opts = null)
    public static Banner get(String name, Output<String> id, BannerState 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:
    Message string
    The organization banner's message.
    Uuid string
    The UUID of the organization banner.
    Message string
    The organization banner's message.
    Uuid string
    The UUID of the organization banner.
    message String
    The organization banner's message.
    uuid String
    The UUID of the organization banner.
    message string
    The organization banner's message.
    uuid string
    The UUID of the organization banner.
    message str
    The organization banner's message.
    uuid str
    The UUID of the organization banner.
    message String
    The organization banner's message.
    uuid String
    The UUID of the organization banner.

    Import

    import an organization banner resource using the banner’s GraphQL ID

    you can use this query to find the banner’s ID:

    query getOrganizationBannerId {

    organization(slug: “ORGANIZATION_SLUG”) {

    banners(first: 1) {
    
      edges {
    
        node {
    
          id
    
        }
    
      }
    
    }
    

    }

    }

    $ pulumi import buildkite:Organization/banner:Banner banner T3JnYW5pemF0aW9uQmFubmVyLS0tNjZlMmE5YzktM2IzMy00OGE5LTk1NjItMzY2YzMwNzYzN2Uz
    

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

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse