1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. iap
  5. Brand
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.iap.Brand

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    Example Usage

    Iap Brand

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const project = new gcp.organizations.Project("project", {
        projectId: "my-project",
        name: "my-project",
        orgId: "123456789",
    });
    const projectService = new gcp.projects.Service("project_service", {
        project: project.projectId,
        service: "iap.googleapis.com",
    });
    const projectBrand = new gcp.iap.Brand("project_brand", {
        supportEmail: "support@example.com",
        applicationTitle: "Cloud IAP protected Application",
        project: projectService.project,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    project = gcp.organizations.Project("project",
        project_id="my-project",
        name="my-project",
        org_id="123456789")
    project_service = gcp.projects.Service("project_service",
        project=project.project_id,
        service="iap.googleapis.com")
    project_brand = gcp.iap.Brand("project_brand",
        support_email="support@example.com",
        application_title="Cloud IAP protected Application",
        project=project_service.project)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/iap"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/projects"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
    			ProjectId: pulumi.String("my-project"),
    			Name:      pulumi.String("my-project"),
    			OrgId:     pulumi.String("123456789"),
    		})
    		if err != nil {
    			return err
    		}
    		projectService, err := projects.NewService(ctx, "project_service", &projects.ServiceArgs{
    			Project: project.ProjectId,
    			Service: pulumi.String("iap.googleapis.com"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = iap.NewBrand(ctx, "project_brand", &iap.BrandArgs{
    			SupportEmail:     pulumi.String("support@example.com"),
    			ApplicationTitle: pulumi.String("Cloud IAP protected Application"),
    			Project:          projectService.Project,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var project = new Gcp.Organizations.Project("project", new()
        {
            ProjectId = "my-project",
            Name = "my-project",
            OrgId = "123456789",
        });
    
        var projectService = new Gcp.Projects.Service("project_service", new()
        {
            Project = project.ProjectId,
            ServiceName = "iap.googleapis.com",
        });
    
        var projectBrand = new Gcp.Iap.Brand("project_brand", new()
        {
            SupportEmail = "support@example.com",
            ApplicationTitle = "Cloud IAP protected Application",
            Project = projectService.Project,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.Project;
    import com.pulumi.gcp.organizations.ProjectArgs;
    import com.pulumi.gcp.projects.Service;
    import com.pulumi.gcp.projects.ServiceArgs;
    import com.pulumi.gcp.iap.Brand;
    import com.pulumi.gcp.iap.BrandArgs;
    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 project = new Project("project", ProjectArgs.builder()
                .projectId("my-project")
                .name("my-project")
                .orgId("123456789")
                .build());
    
            var projectService = new Service("projectService", ServiceArgs.builder()
                .project(project.projectId())
                .service("iap.googleapis.com")
                .build());
    
            var projectBrand = new Brand("projectBrand", BrandArgs.builder()
                .supportEmail("support@example.com")
                .applicationTitle("Cloud IAP protected Application")
                .project(projectService.project())
                .build());
    
        }
    }
    
    resources:
      project:
        type: gcp:organizations:Project
        properties:
          projectId: my-project
          name: my-project
          orgId: '123456789'
      projectService:
        type: gcp:projects:Service
        name: project_service
        properties:
          project: ${project.projectId}
          service: iap.googleapis.com
      projectBrand:
        type: gcp:iap:Brand
        name: project_brand
        properties:
          supportEmail: support@example.com
          applicationTitle: Cloud IAP protected Application
          project: ${projectService.project}
    

    Create Brand Resource

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

    Constructor syntax

    new Brand(name: string, args: BrandArgs, opts?: CustomResourceOptions);
    @overload
    def Brand(resource_name: str,
              args: BrandArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Brand(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              application_title: Optional[str] = None,
              support_email: Optional[str] = None,
              project: Optional[str] = None)
    func NewBrand(ctx *Context, name string, args BrandArgs, opts ...ResourceOption) (*Brand, error)
    public Brand(string name, BrandArgs args, CustomResourceOptions? opts = null)
    public Brand(String name, BrandArgs args)
    public Brand(String name, BrandArgs args, CustomResourceOptions options)
    
    type: gcp:iap:Brand
    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 BrandArgs
    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 BrandArgs
    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 BrandArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BrandArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BrandArgs
    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 brandResource = new Gcp.Iap.Brand("brandResource", new()
    {
        ApplicationTitle = "string",
        SupportEmail = "string",
        Project = "string",
    });
    
    example, err := iap.NewBrand(ctx, "brandResource", &iap.BrandArgs{
    	ApplicationTitle: pulumi.String("string"),
    	SupportEmail:     pulumi.String("string"),
    	Project:          pulumi.String("string"),
    })
    
    var brandResource = new Brand("brandResource", BrandArgs.builder()
        .applicationTitle("string")
        .supportEmail("string")
        .project("string")
        .build());
    
    brand_resource = gcp.iap.Brand("brandResource",
        application_title="string",
        support_email="string",
        project="string")
    
    const brandResource = new gcp.iap.Brand("brandResource", {
        applicationTitle: "string",
        supportEmail: "string",
        project: "string",
    });
    
    type: gcp:iap:Brand
    properties:
        applicationTitle: string
        project: string
        supportEmail: string
    

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

    ApplicationTitle string
    Application name displayed on OAuth consent screen.


    SupportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ApplicationTitle string
    Application name displayed on OAuth consent screen.


    SupportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    applicationTitle String
    Application name displayed on OAuth consent screen.


    supportEmail String
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    applicationTitle string
    Application name displayed on OAuth consent screen.


    supportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    application_title str
    Application name displayed on OAuth consent screen.


    support_email str
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    applicationTitle String
    Application name displayed on OAuth consent screen.


    supportEmail String
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    OrgInternalOnly bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    OrgInternalOnly bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly Boolean
    Whether the brand is only intended for usage inside the GSuite organization only.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly boolean
    Whether the brand is only intended for usage inside the GSuite organization only.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    org_internal_only bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly Boolean
    Whether the brand is only intended for usage inside the GSuite organization only.

    Look up Existing Brand Resource

    Get an existing Brand 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?: BrandState, opts?: CustomResourceOptions): Brand
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_title: Optional[str] = None,
            name: Optional[str] = None,
            org_internal_only: Optional[bool] = None,
            project: Optional[str] = None,
            support_email: Optional[str] = None) -> Brand
    func GetBrand(ctx *Context, name string, id IDInput, state *BrandState, opts ...ResourceOption) (*Brand, error)
    public static Brand Get(string name, Input<string> id, BrandState? state, CustomResourceOptions? opts = null)
    public static Brand get(String name, Output<String> id, BrandState 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:
    ApplicationTitle string
    Application name displayed on OAuth consent screen.


    Name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    OrgInternalOnly bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SupportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    ApplicationTitle string
    Application name displayed on OAuth consent screen.


    Name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    OrgInternalOnly bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SupportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    applicationTitle String
    Application name displayed on OAuth consent screen.


    name String
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly Boolean
    Whether the brand is only intended for usage inside the GSuite organization only.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    supportEmail String
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    applicationTitle string
    Application name displayed on OAuth consent screen.


    name string
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly boolean
    Whether the brand is only intended for usage inside the GSuite organization only.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    supportEmail string
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    application_title str
    Application name displayed on OAuth consent screen.


    name str
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    org_internal_only bool
    Whether the brand is only intended for usage inside the GSuite organization only.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    support_email str
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.
    applicationTitle String
    Application name displayed on OAuth consent screen.


    name String
    Output only. Identifier of the brand, in the format projects/{project_number}/brands/{brand_id} NOTE: The name can also be expressed as projects/{project_id}/brands/{brand_id}, e.g. when importing. NOTE: The brand identification corresponds to the project number as only one brand can be created per project.
    orgInternalOnly Boolean
    Whether the brand is only intended for usage inside the GSuite organization only.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    supportEmail String
    Support email displayed on the OAuth consent screen. Can be either a user or group email. When a user email is specified, the caller must be the user with the associated email address. When a group email is specified, the caller can be either a user or a service account which is an owner of the specified group in Cloud Identity.

    Import

    Brand can be imported using any of these accepted formats:

    • projects/{{project_id}}/brands/{{brand_id}}

    • projects/{{project_number}}/brands/{{brand_id}}

    • {{project_number}}/{{brand_id}}

    When using the pulumi import command, Brand can be imported using one of the formats above. For example:

    $ pulumi import gcp:iap/brand:Brand default projects/{{project_id}}/brands/{{brand_id}}
    
    $ pulumi import gcp:iap/brand:Brand default projects/{{project_number}}/brands/{{brand_id}}
    
    $ pulumi import gcp:iap/brand:Brand default {{project_number}}/{{brand_id}}
    

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi