Client

Contains the data that describes an Identity Aware Proxy owned client.

Note: Only internal org clients can be created via declarative tools. Other types of clients must be manually created via the GCP console. This restriction is due to the existing APIs and not lack of support in this tool.
Warning: All arguments including secret will be stored in the raw state as plain-text. Read more about secrets in state.

Create a Client Resource

new Client(name: string, args: ClientArgs, opts?: CustomResourceOptions);

def Client(resource_name, opts=None, brand=None, display_name=None, __props__=None);

func NewClient(ctx *Context, name string, args ClientArgs, opts ...ResourceOption) (*Client, error)

public Client(string name, ClientArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClientArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Client Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Client resource accepts the following input properties:

Brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
DisplayName string: Human-friendly name given to the OAuth client.

Brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
DisplayName string: Human-friendly name given to the OAuth client.

brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
displayName string: Human-friendly name given to the OAuth client.

brand str: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
display_name str: Human-friendly name given to the OAuth client.

Outputs

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

ClientId string: Output only. Unique identifier of the OAuth client.
Id string: The provider-assigned unique ID for this managed resource.
Secret string: Output only. Client secret of the OAuth client.

ClientId string: Output only. Unique identifier of the OAuth client.
Id string: The provider-assigned unique ID for this managed resource.
Secret string: Output only. Client secret of the OAuth client.

clientId string: Output only. Unique identifier of the OAuth client.
id string: The provider-assigned unique ID for this managed resource.
secret string: Output only. Client secret of the OAuth client.

client_id str: Output only. Unique identifier of the OAuth client.
id str: The provider-assigned unique ID for this managed resource.
secret str: Output only. Client secret of the OAuth client.

Look up an Existing Client Resource

Get an existing Client 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?: ClientState, opts?: CustomResourceOptions): Client

static get(resource_name, id, opts=None, brand=None, client_id=None, display_name=None, secret=None, __props__=None);

func GetClient(ctx *Context, name string, id IDInput, state *ClientState, opts ...ResourceOption) (*Client, error)

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

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.

The following state arguments are supported:

Brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
ClientId string: Output only. Unique identifier of the OAuth client.
DisplayName string: Human-friendly name given to the OAuth client.
Secret string: Output only. Client secret of the OAuth client.

Brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
ClientId string: Output only. Unique identifier of the OAuth client.
DisplayName string: Human-friendly name given to the OAuth client.
Secret string: Output only. Client secret of the OAuth client.

brand string: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
clientId string: Output only. Unique identifier of the OAuth client.
displayName string: Human-friendly name given to the OAuth client.
secret string: Output only. Client secret of the OAuth client.

brand str: Identifier of the brand to which this client is attached to. The format is projects/{project_number}/brands/{brand_id}/identityAwareProxyClients/{client_id}.
client_id str: Output only. Unique identifier of the OAuth client.
display_name str: Human-friendly name given to the OAuth client.
secret str: Output only. Client secret of the OAuth client.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud