Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. iam
  5. iam/v1
  6. WorkloadIdentityPool

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.iam/v1.WorkloadIdentityPool

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. Auto-naming is currently not supported for this resource.

    Create WorkloadIdentityPool Resource

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

    Constructor syntax

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

@overload
def WorkloadIdentityPool(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         workload_identity_pool_id: Optional[str] = None,
                         description: Optional[str] = None,
                         disabled: Optional[bool] = None,
                         display_name: Optional[str] = None,
                         location: Optional[str] = None,
                         project: Optional[str] = None)
    func NewWorkloadIdentityPool(ctx *Context, name string, args WorkloadIdentityPoolArgs, opts ...ResourceOption) (*WorkloadIdentityPool, error)
    public WorkloadIdentityPool(string name, WorkloadIdentityPoolArgs args, CustomResourceOptions? opts = null)
    public WorkloadIdentityPool(String name, WorkloadIdentityPoolArgs args)
public WorkloadIdentityPool(String name, WorkloadIdentityPoolArgs args, CustomResourceOptions options)

    type: google-native:iam/v1:WorkloadIdentityPool
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 WorkloadIdentityPoolArgs
    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 WorkloadIdentityPoolArgs
    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 WorkloadIdentityPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadIdentityPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadIdentityPoolArgs
    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 workloadIdentityPoolResource = new GoogleNative.IAM.V1.WorkloadIdentityPool("workloadIdentityPoolResource", new()
{
    WorkloadIdentityPoolId = "string",
    Description = "string",
    Disabled = false,
    DisplayName = "string",
    Location = "string",
    Project = "string",
});

    example, err := iam.NewWorkloadIdentityPool(ctx, "workloadIdentityPoolResource", &iam.WorkloadIdentityPoolArgs{
	WorkloadIdentityPoolId: pulumi.String("string"),
	Description:            pulumi.String("string"),
	Disabled:               pulumi.Bool(false),
	DisplayName:            pulumi.String("string"),
	Location:               pulumi.String("string"),
	Project:                pulumi.String("string"),
})

    var workloadIdentityPoolResource = new WorkloadIdentityPool("workloadIdentityPoolResource", WorkloadIdentityPoolArgs.builder()
    .workloadIdentityPoolId("string")
    .description("string")
    .disabled(false)
    .displayName("string")
    .location("string")
    .project("string")
    .build());

    workload_identity_pool_resource = google_native.iam.v1.WorkloadIdentityPool("workloadIdentityPoolResource",
    workload_identity_pool_id="string",
    description="string",
    disabled=False,
    display_name="string",
    location="string",
    project="string")

    const workloadIdentityPoolResource = new google_native.iam.v1.WorkloadIdentityPool("workloadIdentityPoolResource", {
    workloadIdentityPoolId: "string",
    description: "string",
    disabled: false,
    displayName: "string",
    location: "string",
    project: "string",
});

    type: google-native:iam/v1:WorkloadIdentityPool
properties:
    description: string
    disabled: false
    displayName: string
    location: string
    project: string
    workloadIdentityPoolId: string

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

    WorkloadIdentityPoolId string
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    Description string
    A description of the pool. Cannot exceed 256 characters.
    Disabled bool
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    DisplayName string
    A display name for the pool. Cannot exceed 32 characters.
    Location string
    Project string
    WorkloadIdentityPoolId string
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    Description string
    A description of the pool. Cannot exceed 256 characters.
    Disabled bool
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    DisplayName string
    A display name for the pool. Cannot exceed 32 characters.
    Location string
    Project string
    workloadIdentityPoolId String
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    description String
    A description of the pool. Cannot exceed 256 characters.
    disabled Boolean
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    displayName String
    A display name for the pool. Cannot exceed 32 characters.
    location String
    project String
    workloadIdentityPoolId string
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    description string
    A description of the pool. Cannot exceed 256 characters.
    disabled boolean
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    displayName string
    A display name for the pool. Cannot exceed 32 characters.
    location string
    project string
    workload_identity_pool_id str
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    description str
    A description of the pool. Cannot exceed 256 characters.
    disabled bool
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    display_name str
    A display name for the pool. Cannot exceed 32 characters.
    location str
    project str
    workloadIdentityPoolId String
    Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
    description String
    A description of the pool. Cannot exceed 256 characters.
    disabled Boolean
    Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
    displayName String
    A display name for the pool. Cannot exceed 32 characters.
    location String
    project String

    Outputs

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

    ExpireTime string
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the pool.
    State string
    The state of the pool.
    ExpireTime string
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the pool.
    State string
    The state of the pool.
    expireTime String
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the pool.
    state String
    The state of the pool.
    expireTime string
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the pool.
    state string
    The state of the pool.
    expire_time str
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the pool.
    state str
    The state of the pool.
    expireTime String
    Time after which the workload identity pool will be permanently purged and cannot be recovered.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the pool.
    state String
    The state of the pool.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native