pulumi-gcp-kotlin/com.pulumi.gcp.kms.kotlin/KmsFunctions/getKMSKeyRing

getKMSKeyRing

suspend fun getKMSKeyRing(argument: GetKMSKeyRingPlainArgs): GetKMSKeyRingResult

Provides access to Google Cloud Platform KMS KeyRing. For more information see the official documentation and API. A KeyRing is a grouping of CryptoKeys for organizational purposes. A KeyRing belongs to a Google Cloud Platform Project and resides in a specific location.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.kms.KmsFunctions;
import com.pulumi.gcp.kms.inputs.GetKMSKeyRingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var myKeyRing = KmsFunctions.getKMSKeyRing(GetKMSKeyRingArgs.builder()
            .location("us-central1")
            .name("my-key-ring")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getKMSKeyRing.

Parameters

argument

A collection of arguments for invoking getKMSKeyRing.

suspend fun getKMSKeyRing(location: String, name: String, project: String? = null): GetKMSKeyRingResult

Return

A collection of values returned by getKMSKeyRing.

Parameters

location

The Google Cloud Platform location for the KeyRing. A full list of valid locations can be found by running gcloud kms locations list.

name

The KeyRing's name. A KeyRing name must exist within the provided location and match the regular expression [a-zA-Z0-9_-]{1,63}

project

The project in which the resource belongs. If it is not provided, the provider project is used.

See also

.

suspend fun getKMSKeyRing(argument: suspend GetKMSKeyRingPlainArgsBuilder.() -> Unit): GetKMSKeyRingResult

Return

A collection of values returned by getKMSKeyRing.

Parameters

argument

Builder for com.pulumi.gcp.kms.kotlin.inputs.GetKMSKeyRingPlainArgs.

See also

.