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. WorkforcePoolKey

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.WorkforcePoolKey

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 WorkforcePoolProviderKey in a WorkforcePoolProvider. Auto-naming is currently not supported for this resource.

    Create WorkforcePoolKey Resource

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

    Constructor syntax

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

@overload
def WorkforcePoolKey(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     provider_id: Optional[str] = None,
                     use: Optional[WorkforcePoolKeyUse] = None,
                     workforce_pool_id: Optional[str] = None,
                     workforce_pool_provider_key_id: Optional[str] = None,
                     key_data: Optional[KeyDataArgs] = None,
                     location: Optional[str] = None)
    func NewWorkforcePoolKey(ctx *Context, name string, args WorkforcePoolKeyArgs, opts ...ResourceOption) (*WorkforcePoolKey, error)
    public WorkforcePoolKey(string name, WorkforcePoolKeyArgs args, CustomResourceOptions? opts = null)
    public WorkforcePoolKey(String name, WorkforcePoolKeyArgs args)
public WorkforcePoolKey(String name, WorkforcePoolKeyArgs args, CustomResourceOptions options)

    type: google-native:iam/v1:WorkforcePoolKey
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 WorkforcePoolKeyArgs
    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 WorkforcePoolKeyArgs
    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 WorkforcePoolKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkforcePoolKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkforcePoolKeyArgs
    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 workforcePoolKeyResource = new GoogleNative.IAM.V1.WorkforcePoolKey("workforcePoolKeyResource", new()
{
    ProviderId = "string",
    Use = GoogleNative.IAM.V1.WorkforcePoolKeyUse.KeyUseUnspecified,
    WorkforcePoolId = "string",
    WorkforcePoolProviderKeyId = "string",
    KeyData = new GoogleNative.IAM.V1.Inputs.KeyDataArgs
    {
        KeySpec = GoogleNative.IAM.V1.KeyDataKeySpec.KeySpecUnspecified,
    },
    Location = "string",
});

    example, err := iam.NewWorkforcePoolKey(ctx, "workforcePoolKeyResource", &iam.WorkforcePoolKeyArgs{
	ProviderId:                 pulumi.String("string"),
	Use:                        iam.WorkforcePoolKeyUseKeyUseUnspecified,
	WorkforcePoolId:            pulumi.String("string"),
	WorkforcePoolProviderKeyId: pulumi.String("string"),
	KeyData: &iam.KeyDataArgs{
		KeySpec: iam.KeyDataKeySpecKeySpecUnspecified,
	},
	Location: pulumi.String("string"),
})

    var workforcePoolKeyResource = new WorkforcePoolKey("workforcePoolKeyResource", WorkforcePoolKeyArgs.builder()
    .providerId("string")
    .use("KEY_USE_UNSPECIFIED")
    .workforcePoolId("string")
    .workforcePoolProviderKeyId("string")
    .keyData(KeyDataArgs.builder()
        .keySpec("KEY_SPEC_UNSPECIFIED")
        .build())
    .location("string")
    .build());

    workforce_pool_key_resource = google_native.iam.v1.WorkforcePoolKey("workforcePoolKeyResource",
    provider_id="string",
    use=google_native.iam.v1.WorkforcePoolKeyUse.KEY_USE_UNSPECIFIED,
    workforce_pool_id="string",
    workforce_pool_provider_key_id="string",
    key_data={
        "key_spec": google_native.iam.v1.KeyDataKeySpec.KEY_SPEC_UNSPECIFIED,
    },
    location="string")

    const workforcePoolKeyResource = new google_native.iam.v1.WorkforcePoolKey("workforcePoolKeyResource", {
    providerId: "string",
    use: google_native.iam.v1.WorkforcePoolKeyUse.KeyUseUnspecified,
    workforcePoolId: "string",
    workforcePoolProviderKeyId: "string",
    keyData: {
        keySpec: google_native.iam.v1.KeyDataKeySpec.KeySpecUnspecified,
    },
    location: "string",
});

    type: google-native:iam/v1:WorkforcePoolKey
properties:
    keyData:
        keySpec: KEY_SPEC_UNSPECIFIED
    location: string
    providerId: string
    use: KEY_USE_UNSPECIFIED
    workforcePoolId: string
    workforcePoolProviderKeyId: string

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

    ProviderId string
    Use Pulumi.GoogleNative.IAM.V1.WorkforcePoolKeyUse
    The purpose of the key.
    WorkforcePoolId string
    WorkforcePoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must 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
    ProviderId string
    Use WorkforcePoolKeyUse
    The purpose of the key.
    WorkforcePoolId string
    WorkforcePoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
    KeyData KeyDataArgs
    Immutable. Public half of the asymmetric key.
    Location string
    providerId String
    use WorkforcePoolKeyUse
    The purpose of the key.
    workforcePoolId String
    workforcePoolProviderKeyId String
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData KeyData
    Immutable. Public half of the asymmetric key.
    location String
    providerId string
    use WorkforcePoolKeyUse
    The purpose of the key.
    workforcePoolId string
    workforcePoolProviderKeyId string
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData KeyData
    Immutable. Public half of the asymmetric key.
    location string
    provider_id str
    use WorkforcePoolKeyUse
    The purpose of the key.
    workforce_pool_id str
    workforce_pool_provider_key_id str
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
    key_data KeyDataArgs
    Immutable. Public half of the asymmetric key.
    location str
    providerId String
    use "KEY_USE_UNSPECIFIED" | "ENCRYPTION"
    The purpose of the key.
    workforcePoolId String
    workforcePoolProviderKeyId String
    Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
    keyData Property Map
    Immutable. Public half of the asymmetric key.
    location String

    Outputs

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

    ExpireTime string
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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
    The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
    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.

    WorkforcePoolKeyUse, WorkforcePoolKeyUseArgs

    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    Encryption
    ENCRYPTIONThe key is used for encryption.
    WorkforcePoolKeyUseKeyUseUnspecified
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    WorkforcePoolKeyUseEncryption
    ENCRYPTIONThe key is used for encryption.
    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    Encryption
    ENCRYPTIONThe key is used for encryption.
    KeyUseUnspecified
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    Encryption
    ENCRYPTIONThe key is used for encryption.
    KEY_USE_UNSPECIFIED
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    ENCRYPTION
    ENCRYPTIONThe key is used for encryption.
    "KEY_USE_UNSPECIFIED"
    KEY_USE_UNSPECIFIEDKeyUse unspecified.
    "ENCRYPTION"
    ENCRYPTIONThe key is used for encryption.

    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