1. Packages
  2. Google Cloud Native
  3. API Docs
  4. iam
  5. iam/v1
  6. WorkloadIdentityPoolKey

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

google-native.iam/v1.WorkloadIdentityPoolKey

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

    Create a new WorkloadIdentityPoolProviderKey in a WorkloadIdentityPoolProvider. Auto-naming is currently not supported for this resource.

    Create WorkloadIdentityPoolKey Resource

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

    Constructor syntax

    new WorkloadIdentityPoolKey(name: string, args: WorkloadIdentityPoolKeyArgs, opts?: CustomResourceOptions);
    @overload
    def WorkloadIdentityPoolKey(resource_name: str,
                                args: WorkloadIdentityPoolKeyArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkloadIdentityPoolKey(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                provider_id: Optional[str] = None,
                                use: Optional[WorkloadIdentityPoolKeyUse] = None,
                                workload_identity_pool_id: Optional[str] = None,
                                workload_identity_pool_provider_key_id: Optional[str] = None,
                                key_data: Optional[KeyDataArgs] = None,
                                location: Optional[str] = None,
                                project: Optional[str] = None)
    func NewWorkloadIdentityPoolKey(ctx *Context, name string, args WorkloadIdentityPoolKeyArgs, opts ...ResourceOption) (*WorkloadIdentityPoolKey, error)
    public WorkloadIdentityPoolKey(string name, WorkloadIdentityPoolKeyArgs args, CustomResourceOptions? opts = null)
    public WorkloadIdentityPoolKey(String name, WorkloadIdentityPoolKeyArgs args)
    public WorkloadIdentityPoolKey(String name, WorkloadIdentityPoolKeyArgs args, CustomResourceOptions options)
    
    type: google-native:iam/v1:WorkloadIdentityPoolKey
    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 WorkloadIdentityPoolKeyArgs
    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 WorkloadIdentityPoolKeyArgs
    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 WorkloadIdentityPoolKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadIdentityPoolKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadIdentityPoolKeyArgs
    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 workloadIdentityPoolKeyResource = new GoogleNative.IAM.V1.WorkloadIdentityPoolKey("workloadIdentityPoolKeyResource", new()
    {
        ProviderId = "string",
        Use = GoogleNative.IAM.V1.WorkloadIdentityPoolKeyUse.KeyUseUnspecified,
        WorkloadIdentityPoolId = "string",
        WorkloadIdentityPoolProviderKeyId = "string",
        KeyData = new GoogleNative.IAM.V1.Inputs.KeyDataArgs
        {
            KeySpec = GoogleNative.IAM.V1.KeyDataKeySpec.KeySpecUnspecified,
        },
        Location = "string",
        Project = "string",
    });
    
    example, err := iam.NewWorkloadIdentityPoolKey(ctx, "workloadIdentityPoolKeyResource", &iam.WorkloadIdentityPoolKeyArgs{
    	ProviderId:                        pulumi.String("string"),
    	Use:                               iam.WorkloadIdentityPoolKeyUseKeyUseUnspecified,
    	WorkloadIdentityPoolId:            pulumi.String("string"),
    	WorkloadIdentityPoolProviderKeyId: pulumi.String("string"),
    	KeyData: &iam.KeyDataArgs{
    		KeySpec: iam.KeyDataKeySpecKeySpecUnspecified,
    	},
    	Location: pulumi.String("string"),
    	Project:  pulumi.String("string"),
    })
    
    var workloadIdentityPoolKeyResource = new WorkloadIdentityPoolKey("workloadIdentityPoolKeyResource", WorkloadIdentityPoolKeyArgs.builder()
        .providerId("string")
        .use("KEY_USE_UNSPECIFIED")
        .workloadIdentityPoolId("string")
        .workloadIdentityPoolProviderKeyId("string")
        .keyData(KeyDataArgs.builder()
            .keySpec("KEY_SPEC_UNSPECIFIED")
            .build())
        .location("string")
        .project("string")
        .build());
    
    workload_identity_pool_key_resource = google_native.iam.v1.WorkloadIdentityPoolKey("workloadIdentityPoolKeyResource",
        provider_id="string",
        use=google_native.iam.v1.WorkloadIdentityPoolKeyUse.KEY_USE_UNSPECIFIED,
        workload_identity_pool_id="string",
        workload_identity_pool_provider_key_id="string",
        key_data={
            "key_spec": google_native.iam.v1.KeyDataKeySpec.KEY_SPEC_UNSPECIFIED,
        },
        location="string",
        project="string")
    
    const workloadIdentityPoolKeyResource = new google_native.iam.v1.WorkloadIdentityPoolKey("workloadIdentityPoolKeyResource", {
        providerId: "string",
        use: google_native.iam.v1.WorkloadIdentityPoolKeyUse.KeyUseUnspecified,
        workloadIdentityPoolId: "string",
        workloadIdentityPoolProviderKeyId: "string",
        keyData: {
            keySpec: google_native.iam.v1.KeyDataKeySpec.KeySpecUnspecified,
        },
        location: "string",
        project: "string",
    });
    
    type: google-native:iam/v1:WorkloadIdentityPoolKey
    properties:
        keyData:
            keySpec: KEY_SPEC_UNSPECIFIED
        location: string
        project: string
        providerId: string
        use: KEY_USE_UNSPECIFIED
        workloadIdentityPoolId: string
        workloadIdentityPoolProviderKeyId: string
    

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

    ProviderId string
    Use Pulumi.GoogleNative.IAM.V1.WorkloadIdentityPoolKeyUse
    The purpose of the key.
    WorkloadIdentityPoolId string
    WorkloadIdentityPoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    KeyData Pulumi.GoogleNative.IAM.V1.Inputs.KeyData
    Immutable. Public half of the asymmetric key.
    Location string
    Project string
    ProviderId string
    Use WorkloadIdentityPoolKeyUse
    The purpose of the key.
    WorkloadIdentityPoolId string
    WorkloadIdentityPoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    KeyData KeyDataArgs
    Immutable. Public half of the asymmetric key.
    Location string
    Project string
    providerId String
    use WorkloadIdentityPoolKeyUse
    The purpose of the key.
    workloadIdentityPoolId String
    workloadIdentityPoolProviderKeyId String
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData KeyData
    Immutable. Public half of the asymmetric key.
    location String
    project String
    providerId string
    use WorkloadIdentityPoolKeyUse
    The purpose of the key.
    workloadIdentityPoolId string
    workloadIdentityPoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData KeyData
    Immutable. Public half of the asymmetric key.
    location string
    project string
    provider_id str
    use WorkloadIdentityPoolKeyUse
    The purpose of the key.
    workload_identity_pool_id str
    workload_identity_pool_provider_key_id str
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    key_data KeyDataArgs
    Immutable. Public half of the asymmetric key.
    location str
    project str
    providerId String
    use "KEY_USE_UNSPECIFIED" | "ENCRYPTION"
    The purpose of the key.
    workloadIdentityPoolId String
    workloadIdentityPoolProviderKeyId String
    Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData Property Map
    Immutable. Public half of the asymmetric key.
    location String
    project String

    Outputs

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

    ExpireTime string
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the key.
    State string
    The state of the key.
    ExpireTime string
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the key.
    State string
    The state of the key.
    expireTime String
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the key.
    state String
    The state of the key.
    expireTime string
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the key.
    state string
    The state of the key.
    expire_time str
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the key.
    state str
    The state of the key.
    expireTime String
    Time after which the key will be permanently purged and cannot be recovered. Note that the key may get purged before this timestamp if the total limit of keys per provider is crossed.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the key.
    state String
    The state of the key.

    Supporting Types

    KeyData, KeyDataArgs

    KeySpec Pulumi.GoogleNative.IAM.V1.KeyDataKeySpec
    The specifications for the key.
    KeySpec KeyDataKeySpec
    The specifications for the key.
    keySpec KeyDataKeySpec
    The specifications for the key.
    keySpec KeyDataKeySpec
    The specifications for the key.
    key_spec KeyDataKeySpec
    The specifications for the key.

    KeyDataKeySpec, KeyDataKeySpecArgs

    KeySpecUnspecified
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    Rsa2048
    RSA_2048A 2048 bit RSA key.
    Rsa3072
    RSA_3072A 3072 bit RSA key.
    Rsa4096
    RSA_4096A 4096 bit RSA key.
    KeyDataKeySpecKeySpecUnspecified
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    KeyDataKeySpecRsa2048
    RSA_2048A 2048 bit RSA key.
    KeyDataKeySpecRsa3072
    RSA_3072A 3072 bit RSA key.
    KeyDataKeySpecRsa4096
    RSA_4096A 4096 bit RSA key.
    KeySpecUnspecified
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    Rsa2048
    RSA_2048A 2048 bit RSA key.
    Rsa3072
    RSA_3072A 3072 bit RSA key.
    Rsa4096
    RSA_4096A 4096 bit RSA key.
    KeySpecUnspecified
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    Rsa2048
    RSA_2048A 2048 bit RSA key.
    Rsa3072
    RSA_3072A 3072 bit RSA key.
    Rsa4096
    RSA_4096A 4096 bit RSA key.
    KEY_SPEC_UNSPECIFIED
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    RSA2048
    RSA_2048A 2048 bit RSA key.
    RSA3072
    RSA_3072A 3072 bit RSA key.
    RSA4096
    RSA_4096A 4096 bit RSA key.
    "KEY_SPEC_UNSPECIFIED"
    KEY_SPEC_UNSPECIFIEDNo key specification specified.
    "RSA_2048"
    RSA_2048A 2048 bit RSA key.
    "RSA_3072"
    RSA_3072A 3072 bit RSA key.
    "RSA_4096"
    RSA_4096A 4096 bit RSA key.

    KeyDataResponse, KeyDataResponseArgs

    Format string
    The format of the key.
    Key string
    The key data. The format of the key is represented by the format field.
    KeySpec string
    The specifications for the key.
    NotAfterTime string
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    NotBeforeTime string
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
    Format string
    The format of the key.
    Key string
    The key data. The format of the key is represented by the format field.
    KeySpec string
    The specifications for the key.
    NotAfterTime string
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    NotBeforeTime string
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
    format String
    The format of the key.
    key String
    The key data. The format of the key is represented by the format field.
    keySpec String
    The specifications for the key.
    notAfterTime String
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    notBeforeTime String
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
    format string
    The format of the key.
    key string
    The key data. The format of the key is represented by the format field.
    keySpec string
    The specifications for the key.
    notAfterTime string
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    notBeforeTime string
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
    format str
    The format of the key.
    key str
    The key data. The format of the key is represented by the format field.
    key_spec str
    The specifications for the key.
    not_after_time str
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    not_before_time str
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
    format String
    The format of the key.
    key String
    The key data. The format of the key is represented by the format field.
    keySpec String
    The specifications for the key.
    notAfterTime String
    Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
    notBeforeTime String
    Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.

    WorkloadIdentityPoolKeyUse, WorkloadIdentityPoolKeyUseArgs

    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDThe key use is not known.
    Encryption
    ENCRYPTIONThe public key is used for encryption purposes.
    WorkloadIdentityPoolKeyUseKeyUseUnspecified
    KEY_USE_UNSPECIFIEDThe key use is not known.
    WorkloadIdentityPoolKeyUseEncryption
    ENCRYPTIONThe public key is used for encryption purposes.
    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDThe key use is not known.
    Encryption
    ENCRYPTIONThe public key is used for encryption purposes.
    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDThe key use is not known.
    Encryption
    ENCRYPTIONThe public key is used for encryption purposes.
    KEY_USE_UNSPECIFIED
    KEY_USE_UNSPECIFIEDThe key use is not known.
    ENCRYPTION
    ENCRYPTIONThe public key is used for encryption purposes.
    "KEY_USE_UNSPECIFIED"
    KEY_USE_UNSPECIFIEDThe key use is not known.
    "ENCRYPTION"
    ENCRYPTIONThe public key is used for encryption purposes.

    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