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

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.cloudkms/v1.KeyRing

Explore with Pulumi AI

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

Create a new KeyRing in a given Project and Location. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Create KeyRing Resource

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

Constructor syntax

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

@overload
def KeyRing(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            key_ring_id: Optional[str] = None,
            location: Optional[str] = None,
            project: Optional[str] = None)
func NewKeyRing(ctx *Context, name string, args *KeyRingArgs, opts ...ResourceOption) (*KeyRing, error)
public KeyRing(string name, KeyRingArgs? args = null, CustomResourceOptions? opts = null)
public KeyRing(String name, KeyRingArgs args)
public KeyRing(String name, KeyRingArgs args, CustomResourceOptions options)

type: google-native:cloudkms/v1:KeyRing
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 KeyRingArgs
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 KeyRingArgs
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 KeyRingArgs
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 KeyRingArgs
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. KeyRingArgs
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 keyRingResource = new GoogleNative.Cloudkms.V1.KeyRing("keyRingResource", new()
{
    KeyRingId = "string",
    Location = "string",
    Project = "string",
});
Copy
example, err := cloudkms.NewKeyRing(ctx, "keyRingResource", &cloudkms.KeyRingArgs{
	KeyRingId: pulumi.String("string"),
	Location:  pulumi.String("string"),
	Project:   pulumi.String("string"),
})
Copy
var keyRingResource = new KeyRing("keyRingResource", KeyRingArgs.builder()
    .keyRingId("string")
    .location("string")
    .project("string")
    .build());
Copy
key_ring_resource = google_native.cloudkms.v1.KeyRing("keyRingResource",
    key_ring_id="string",
    location="string",
    project="string")
Copy
const keyRingResource = new google_native.cloudkms.v1.KeyRing("keyRingResource", {
    keyRingId: "string",
    location: "string",
    project: "string",
});
Copy
type: google-native:cloudkms/v1:KeyRing
properties:
    keyRingId: string
    location: string
    project: string
Copy

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

KeyRingId Changes to this property will trigger replacement. string
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
KeyRingId Changes to this property will trigger replacement. string
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
keyRingId Changes to this property will trigger replacement. String
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
keyRingId Changes to this property will trigger replacement. string
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
key_ring_id Changes to this property will trigger replacement. str
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
keyRingId Changes to this property will trigger replacement. String
Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String

Outputs

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

CreateTime string
The time at which this KeyRing was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
CreateTime string
The time at which this KeyRing was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
createTime String
The time at which this KeyRing was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
createTime string
The time at which this KeyRing was created.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
create_time str
The time at which this KeyRing was created.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
createTime String
The time at which this KeyRing was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.

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.

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