Package com.hashicorp.cdktf.providers.google.privateca_certificate_authority

Interface PrivatecaCertificateAuthorityConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    PrivatecaCertificateAuthorityConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.361Z")
@Stability(Stable)
public interface PrivatecaCertificateAuthorityConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCertificateAuthorityId

        @Stability(Stable)
@NotNull
String getCertificateAuthorityId()
        The user provided Resource ID for this Certificate Authority.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#certificate_authority_id PrivatecaCertificateAuthority#certificate_authority_id}

      • getConfig

        @Stability(Stable)
@NotNull
PrivatecaCertificateAuthorityConfigA getConfig()
        config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#config PrivatecaCertificateAuthority#config}

      • getKeySpec

        @Stability(Stable)
@NotNull
PrivatecaCertificateAuthorityKeySpec getKeySpec()
        key_spec block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#key_spec PrivatecaCertificateAuthority#key_spec}

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        Location of the CertificateAuthority. A full list of valid locations can be found by running 'gcloud privateca locations list'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#location PrivatecaCertificateAuthority#location}

      • getPool

        @Stability(Stable)
@NotNull
String getPool()
        The name of the CaPool this Certificate Authority belongs to.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#pool PrivatecaCertificateAuthority#pool}

      • getDeletionProtection

        @Stability(Stable)
@Nullable
default Object getDeletionProtection()
        Whether Terraform will be prevented from destroying the CertificateAuthority.

        When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the CertificateAuthority will fail. When the field is set to false, deleting the CertificateAuthority is allowed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#deletion_protection PrivatecaCertificateAuthority#deletion_protection}

      • getDesiredState

        @Stability(Stable)
@Nullable
default String getDesiredState()
        Desired state of the CertificateAuthority. Set this field to 'STAGED' to create a 'STAGED' root CA.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#desired_state PrivatecaCertificateAuthority#desired_state}

      • getGcsBucket

        @Stability(Stable)
@Nullable
default String getGcsBucket()
        The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs.

        This must be a bucket name, without any prefixes (such as 'gs://') or suffixes (such as '.googleapis.com'). For example, to use a bucket named my-bucket, you would simply specify 'my-bucket'. If not specified, a managed bucket will be created. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#gcs_bucket PrivatecaCertificateAuthority#gcs_bucket}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#id PrivatecaCertificateAuthority#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getIgnoreActiveCertificatesOnDeletion

        @Stability(Stable)
@Nullable
default Object getIgnoreActiveCertificatesOnDeletion()
        This field allows the CA to be deleted even if the CA has active certs.

        Active certs include both unrevoked and unexpired certs. Use with care. Defaults to 'false'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#ignore_active_certificates_on_deletion PrivatecaCertificateAuthority#ignore_active_certificates_on_deletion}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        Labels with user-defined metadata.

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#labels PrivatecaCertificateAuthority#labels}

      • getLifetime

        @Stability(Stable)
@Nullable
default String getLifetime()
        The desired lifetime of the CA certificate.

        Used to create the "notBeforeTime" and "notAfterTime" fields inside an X.509 certificate. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#lifetime PrivatecaCertificateAuthority#lifetime}

      • getPemCaCertificate

        @Stability(Stable)
@Nullable
default String getPemCaCertificate()
        The signed CA certificate issued from the subordinated CA's CSR.

        This is needed when activating the subordiante CA with a third party issuer. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#pem_ca_certificate PrivatecaCertificateAuthority#pem_ca_certificate}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#project PrivatecaCertificateAuthority#project}.

      • getSkipGracePeriod

        @Stability(Stable)
@Nullable
default Object getSkipGracePeriod()
        If this flag is set, the Certificate Authority will be deleted as soon as possible without a 30-day grace period where undeletion would have been allowed.

        If you proceed, there will be no way to recover this CA. Use with care. Defaults to 'false'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#skip_grace_period PrivatecaCertificateAuthority#skip_grace_period}

      • getSubordinateConfig

        @Stability(Stable)
@Nullable
default PrivatecaCertificateAuthoritySubordinateConfig getSubordinateConfig()
        subordinate_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#subordinate_config PrivatecaCertificateAuthority#subordinate_config}

      • getTimeouts

        @Stability(Stable)
@Nullable
default PrivatecaCertificateAuthorityTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#timeouts PrivatecaCertificateAuthority#timeouts}

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        The Type of this CertificateAuthority.

        ~> **Note:** For 'SUBORDINATE' Certificate Authorities, they need to be activated before they can issue certificates. Default value: "SELF_SIGNED" Possible values: ["SELF_SIGNED", "SUBORDINATE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#type PrivatecaCertificateAuthority#type}