gcp.certificatemanager.getCertificates
Explore with Pulumi AI
List all certificates within Google Certificate Manager for a given project, region or filter.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const default = gcp.certificatemanager.getCertificates({});
import pulumi
import pulumi_gcp as gcp
default = gcp.certificatemanager.get_certificates()
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/certificatemanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := certificatemanager.GetCertificates(ctx, &certificatemanager.GetCertificatesArgs{}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = Gcp.CertificateManager.GetCertificates.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.certificatemanager.CertificatemanagerFunctions;
import com.pulumi.gcp.certificatemanager.inputs.GetCertificatesArgs;
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 default = CertificatemanagerFunctions.getCertificates();
}
}
variables:
default:
fn::invoke:
Function: gcp:certificatemanager:getCertificates
Arguments: {}
With A Filter
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-*",
});
import pulumi
import pulumi_gcp as gcp
default = gcp.certificatemanager.get_certificates(filter="name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/certificatemanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := certificatemanager.GetCertificates(ctx, &certificatemanager.GetCertificatesArgs{
Filter: pulumi.StringRef("name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = Gcp.CertificateManager.GetCertificates.Invoke(new()
{
Filter = "name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.certificatemanager.CertificatemanagerFunctions;
import com.pulumi.gcp.certificatemanager.inputs.GetCertificatesArgs;
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 default = CertificatemanagerFunctions.getCertificates(GetCertificatesArgs.builder()
.filter("name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*")
.build());
}
}
variables:
default:
fn::invoke:
Function: gcp:certificatemanager:getCertificates
Arguments:
filter: name:projects/PROJECT_ID/locations/REGION/certificates/certificate-name-*
Using getCertificates
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCertificates(args: GetCertificatesArgs, opts?: InvokeOptions): Promise<GetCertificatesResult>
function getCertificatesOutput(args: GetCertificatesOutputArgs, opts?: InvokeOptions): Output<GetCertificatesResult>
def get_certificates(filter: Optional[str] = None,
region: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCertificatesResult
def get_certificates_output(filter: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCertificatesResult]
func GetCertificates(ctx *Context, args *GetCertificatesArgs, opts ...InvokeOption) (*GetCertificatesResult, error)
func GetCertificatesOutput(ctx *Context, args *GetCertificatesOutputArgs, opts ...InvokeOption) GetCertificatesResultOutput
> Note: This function is named GetCertificates
in the Go SDK.
public static class GetCertificates
{
public static Task<GetCertificatesResult> InvokeAsync(GetCertificatesArgs args, InvokeOptions? opts = null)
public static Output<GetCertificatesResult> Invoke(GetCertificatesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCertificatesResult> getCertificates(GetCertificatesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:certificatemanager/getCertificates:getCertificates
arguments:
# arguments dictionary
The following arguments are supported:
getCertificates Result
The following output properties are available:
- Certificates
List<Get
Certificates Certificate> - Id string
- The provider-assigned unique ID for this managed resource.
- Filter string
- Region string
- Certificates
[]Get
Certificates Certificate - Id string
- The provider-assigned unique ID for this managed resource.
- Filter string
- Region string
- certificates
List<Get
Certificates Certificate> - id String
- The provider-assigned unique ID for this managed resource.
- filter String
- region String
- certificates
Get
Certificates Certificate[] - id string
- The provider-assigned unique ID for this managed resource.
- filter string
- region string
- certificates
Sequence[Get
Certificates Certificate] - id str
- The provider-assigned unique ID for this managed resource.
- filter str
- region str
- certificates List<Property Map>
- id String
- The provider-assigned unique ID for this managed resource.
- filter String
- region String
Supporting Types
GetCertificatesCertificate
- Description string
- A human-readable description of the resource.
- Effective
Labels Dictionary<string, string> - Labels Dictionary<string, string>
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- Location string
- The Certificate Manager location. If not specified, "global" is used.
- Manageds
List<Get
Certificates Certificate Managed> - Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- Name string
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- San
Dnsnames List<string> - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- Scope string
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
- Description string
- A human-readable description of the resource.
- Effective
Labels map[string]string - Labels map[string]string
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- Location string
- The Certificate Manager location. If not specified, "global" is used.
- Manageds
[]Get
Certificates Certificate Managed - Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- Name string
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- San
Dnsnames []string - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- Scope string
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
- description String
- A human-readable description of the resource.
- effective
Labels Map<String,String> - labels Map<String,String>
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- location String
- The Certificate Manager location. If not specified, "global" is used.
- manageds
List<Get
Certificates Certificate Managed> - Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- name String
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- san
Dnsnames List<String> - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- scope String
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
- description string
- A human-readable description of the resource.
- effective
Labels {[key: string]: string} - labels {[key: string]: string}
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- location string
- The Certificate Manager location. If not specified, "global" is used.
- manageds
Get
Certificates Certificate Managed[] - Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- name string
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- san
Dnsnames string[] - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- scope string
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
- description str
- A human-readable description of the resource.
- effective_
labels Mapping[str, str] - labels Mapping[str, str]
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- location str
- The Certificate Manager location. If not specified, "global" is used.
- manageds
Sequence[Get
Certificates Certificate Managed] - Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- name str
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- san_
dnsnames Sequence[str] - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- scope str
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
- description String
- A human-readable description of the resource.
- effective
Labels Map<String> - labels Map<String>
Set of label tags associated with the Certificate resource.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
- location String
- The Certificate Manager location. If not specified, "global" is used.
- manageds List<Property Map>
- Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.
- name String
- A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- san
Dnsnames List<String> - The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6)
- scope String
The scope of the certificate.
DEFAULT: Certificates with default scope are served from core Google data centers. If unsure, choose this option.
EDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.
ALL_REGIONS: Certificates with ALL_REGIONS scope are served from all GCP regions (You can only use ALL_REGIONS with global certs). See https://cloud.google.com/compute/docs/regions-zones
GetCertificatesCertificateManaged
- List<Get
Certificates Certificate Managed Authorization Attempt Info> - Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- List<string>
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- Domains List<string>
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- Issuance
Config string - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- Provisioning
Issues List<GetCertificates Certificate Managed Provisioning Issue> - Information about issues with provisioning this Managed Certificate.
- State string
- A state of this Managed Certificate.
- []Get
Certificates Certificate Managed Authorization Attempt Info - Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- []string
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- Domains []string
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- Issuance
Config string - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- Provisioning
Issues []GetCertificates Certificate Managed Provisioning Issue - Information about issues with provisioning this Managed Certificate.
- State string
- A state of this Managed Certificate.
- List<Get
Certificates Certificate Managed Authorization Attempt Info> - Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- List<String>
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- domains List<String>
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- issuance
Config String - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- provisioning
Issues List<GetCertificates Certificate Managed Provisioning Issue> - Information about issues with provisioning this Managed Certificate.
- state String
- A state of this Managed Certificate.
- Get
Certificates Certificate Managed Authorization Attempt Info[] - Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- string[]
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- domains string[]
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- issuance
Config string - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- provisioning
Issues GetCertificates Certificate Managed Provisioning Issue[] - Information about issues with provisioning this Managed Certificate.
- state string
- A state of this Managed Certificate.
- Sequence[Get
Certificates Certificate Managed Authorization Attempt Info] - Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- Sequence[str]
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- domains Sequence[str]
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- issuance_
config str - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- provisioning_
issues Sequence[GetCertificates Certificate Managed Provisioning Issue] - Information about issues with provisioning this Managed Certificate.
- state str
- A state of this Managed Certificate.
- List<Property Map>
- Detailed state of the latest authorization attempt for each domain specified for this Managed Certificate.
- List<String>
- Authorizations that will be used for performing domain authorization. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- domains List<String>
- The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution
- issuance
Config String - The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects//locations//certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. Either issuanceConfig or dnsAuthorizations should be specificed, but not both.
- provisioning
Issues List<Property Map> - Information about issues with provisioning this Managed Certificate.
- state String
- A state of this Managed Certificate.
GetCertificatesCertificateManagedAuthorizationAttemptInfo
- Details string
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- Domain string
- Domain name of the authorization attempt.
- Failure
Reason string - Reason for failure of the authorization attempt for the domain.
- State string
- State of the domain for managed certificate issuance.
- Details string
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- Domain string
- Domain name of the authorization attempt.
- Failure
Reason string - Reason for failure of the authorization attempt for the domain.
- State string
- State of the domain for managed certificate issuance.
- details String
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- domain String
- Domain name of the authorization attempt.
- failure
Reason String - Reason for failure of the authorization attempt for the domain.
- state String
- State of the domain for managed certificate issuance.
- details string
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- domain string
- Domain name of the authorization attempt.
- failure
Reason string - Reason for failure of the authorization attempt for the domain.
- state string
- State of the domain for managed certificate issuance.
- details str
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- domain str
- Domain name of the authorization attempt.
- failure_
reason str - Reason for failure of the authorization attempt for the domain.
- state str
- State of the domain for managed certificate issuance.
- details String
- Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use 'failure_reason' field.
- domain String
- Domain name of the authorization attempt.
- failure
Reason String - Reason for failure of the authorization attempt for the domain.
- state String
- State of the domain for managed certificate issuance.
GetCertificatesCertificateManagedProvisioningIssue
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.