@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
122 lines • 4.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* List all certificates within Google Certificate Manager for a given project, region or filter.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({});
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*
* ### With A Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({
* filter: "name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*",
* });
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*
* ### Regional Certificates With A Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({
* region: "REGION",
* filter: "name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*",
* });
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*/
export declare function getCertificates(args?: GetCertificatesArgs, opts?: pulumi.InvokeOptions): Promise<GetCertificatesResult>;
/**
* A collection of arguments for invoking getCertificates.
*/
export interface GetCertificatesArgs {
/**
* Filter expression to restrict the certificates returned.
*/
filter?: string;
/**
* The region in which the resource belongs. If it is not provided, `GLOBAL` is used.
*/
region?: string;
}
/**
* A collection of values returned by getCertificates.
*/
export interface GetCertificatesResult {
/**
* A list of all retrieved certificates. See gcp.certificatemanager.Certificate resource for details of the available attributes.
*/
readonly certificates: outputs.certificatemanager.GetCertificatesCertificate[];
readonly filter?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly region?: string;
}
/**
* List all certificates within Google Certificate Manager for a given project, region or filter.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({});
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*
* ### With A Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({
* filter: "name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*",
* });
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*
* ### Regional Certificates With A Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.certificatemanager.getCertificates({
* region: "REGION",
* filter: "name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*",
* });
* export const certificatesNames = _default.then(_default => .map(cert => (cert.name)));
* ```
*/
export declare function getCertificatesOutput(args?: GetCertificatesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCertificatesResult>;
/**
* A collection of arguments for invoking getCertificates.
*/
export interface GetCertificatesOutputArgs {
/**
* Filter expression to restrict the certificates returned.
*/
filter?: pulumi.Input<string | undefined>;
/**
* The region in which the resource belongs. If it is not provided, `GLOBAL` is used.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getCertificates.d.ts.map