Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.iam/v1.WorkloadIdentityPoolKey
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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
This property is required. string - The unique name of the resource.
- args
This property is required. WorkloadIdentityPoolKeyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. WorkloadIdentityPoolKeyArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. WorkloadIdentityPoolKeyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Provider
Id This property is required. Changes to this property will trigger replacement.
- Use
This property is required. Pulumi.Google Native. IAM. V1. Workload Identity Pool Key Use - The purpose of the key.
- Workload
Identity Pool Id This property is required. Changes to this property will trigger replacement.
- Workload
Identity Pool Provider Key Id This property is required. Changes to this property will trigger replacement.
- 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 Pulumi.Google Native. IAM. V1. Inputs. Key Data - Immutable. Public half of the asymmetric key.
- Location
Changes to this property will trigger replacement.
- Project
Changes to this property will trigger replacement.
- Provider
Id This property is required. Changes to this property will trigger replacement.
- Use
This property is required. WorkloadIdentity Pool Key Use - The purpose of the key.
- Workload
Identity Pool Id This property is required. Changes to this property will trigger replacement.
- Workload
Identity Pool Provider Key Id This property is required. Changes to this property will trigger replacement.
- 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 KeyData Args - Immutable. Public half of the asymmetric key.
- Location
Changes to this property will trigger replacement.
- Project
Changes to this property will trigger replacement.
- provider
Id This property is required. Changes to this property will trigger replacement.
- use
This property is required. WorkloadIdentity Pool Key Use - The purpose of the key.
- workload
Identity Pool Id This property is required. Changes to this property will trigger replacement.
- workload
Identity Pool Provider Key Id This property is required. Changes to this property will trigger replacement.
- 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 KeyData - Immutable. Public half of the asymmetric key.
- location
Changes to this property will trigger replacement.
- project
Changes to this property will trigger replacement.
- provider
Id This property is required. Changes to this property will trigger replacement.
- use
This property is required. WorkloadIdentity Pool Key Use - The purpose of the key.
- workload
Identity Pool Id This property is required. Changes to this property will trigger replacement.
- workload
Identity Pool Provider Key Id This property is required. Changes to this property will trigger replacement.
- 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 KeyData - Immutable. Public half of the asymmetric key.
- location
Changes to this property will trigger replacement.
- project
Changes to this property will trigger replacement.
- provider_
id This property is required. Changes to this property will trigger replacement.
- use
This property is required. WorkloadIdentity Pool Key Use - The purpose of the key.
- workload_
identity_ pool_ id This property is required. Changes to this property will trigger replacement.
- workload_
identity_ pool_ provider_ key_ id This property is required. Changes to this property will trigger replacement.
- 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 KeyData Args - Immutable. Public half of the asymmetric key.
- location
Changes to this property will trigger replacement.
- project
Changes to this property will trigger replacement.
- provider
Id This property is required. Changes to this property will trigger replacement.
- use
This property is required. "KEY_USE_UNSPECIFIED" | "ENCRYPTION" - The purpose of the key.
- workload
Identity Pool Id This property is required. Changes to this property will trigger replacement.
- workload
Identity Pool Provider Key Id This property is required. Changes to this property will trigger replacement.
- 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 Property Map - Immutable. Public half of the asymmetric key.
- location
Changes to this property will trigger replacement.
- project
Changes to this property will trigger replacement.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkloadIdentityPoolKey resource produces the following output properties:
- Expire
Time 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 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 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 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.
- expire
Time 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
- Key
Spec This property is required. Pulumi.Google Native. IAM. V1. Key Data Key Spec - The specifications for the key.
- Key
Spec This property is required. KeyData Key Spec - The specifications for the key.
- key
Spec This property is required. KeyData Key Spec - The specifications for the key.
- key
Spec This property is required. KeyData Key Spec - The specifications for the key.
- key_
spec This property is required. KeyData Key Spec - The specifications for the key.
- key
Spec This property is required. "KEY_SPEC_UNSPECIFIED" | "RSA_2048" | "RSA_3072" | "RSA_4096" - The specifications for the key.
KeyDataKeySpec, KeyDataKeySpecArgs
- 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
Data Key Spec Key Spec Unspecified - KEY_SPEC_UNSPECIFIEDNo key specification specified.
- Key
Data Key Spec Rsa2048 - RSA_2048A 2048 bit RSA key.
- Key
Data Key Spec Rsa3072 - RSA_3072A 3072 bit RSA key.
- Key
Data Key Spec 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.
- 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
This property is required. string - The format of the key.
- Key
This property is required. string - The key data. The format of the key is represented by the format field.
- Key
Spec This property is required. string - The specifications for the key.
- Not
After Time This property is required. 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.
- Not
Before Time This property is required. 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
This property is required. string - The format of the key.
- Key
This property is required. string - The key data. The format of the key is represented by the format field.
- Key
Spec This property is required. string - The specifications for the key.
- Not
After Time This property is required. 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.
- Not
Before Time This property is required. 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
This property is required. String - The format of the key.
- key
This property is required. String - The key data. The format of the key is represented by the format field.
- key
Spec This property is required. String - The specifications for the key.
- not
After Time This property is required. 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.
- not
Before Time This property is required. 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
This property is required. string - The format of the key.
- key
This property is required. string - The key data. The format of the key is represented by the format field.
- key
Spec This property is required. string - The specifications for the key.
- not
After Time This property is required. 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.
- not
Before Time This property is required. 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
This property is required. str - The format of the key.
- key
This property is required. str - The key data. The format of the key is represented by the format field.
- key_
spec This property is required. str - The specifications for the key.
- not_
after_ time This property is required. 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 This property is required. 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
This property is required. String - The format of the key.
- key
This property is required. String - The key data. The format of the key is represented by the format field.
- key
Spec This property is required. String - The specifications for the key.
- not
After Time This property is required. 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.
- not
Before Time This property is required. 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
- Key
Use Unspecified - KEY_USE_UNSPECIFIEDThe key use is not known.
- Encryption
- ENCRYPTIONThe public key is used for encryption purposes.
- Workload
Identity Pool Key Use Key Use Unspecified - KEY_USE_UNSPECIFIEDThe key use is not known.
- Workload
Identity Pool Key Use 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.
- 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 Cloud Native is in preview. Google Cloud Classic is fully supported.