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

Class PrivatecaCertificateAuthority.Builder

    • Method Detail

      • connection

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public PrivatecaCertificateAuthority.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • certificateAuthorityId

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder certificateAuthorityId​(String certificateAuthorityId)
        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}

        Parameters:
        certificateAuthorityId - The user provided Resource ID for this Certificate Authority. This parameter is required.
        Returns:
        this

      • config

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder config​(PrivatecaCertificateAuthorityConfigA config)
        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}

        Parameters:
        config - config block. This parameter is required.
        Returns:
        this

      • keySpec

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder keySpec​(PrivatecaCertificateAuthorityKeySpec keySpec)
        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}

        Parameters:
        keySpec - key_spec block. This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder location​(String location)
        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}

        Parameters:
        location - Location of the CertificateAuthority. A full list of valid locations can be found by running 'gcloud privateca locations list'. This parameter is required.
        Returns:
        this

      • pool

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder pool​(String pool)
        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}

        Parameters:
        pool - The name of the CaPool this Certificate Authority belongs to. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder deletionProtection​(Boolean deletionProtection)
        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}

        Parameters:
        deletionProtection - Whether Terraform will be prevented from destroying the CertificateAuthority. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder deletionProtection​(com.hashicorp.cdktf.IResolvable deletionProtection)
        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}

        Parameters:
        deletionProtection - Whether Terraform will be prevented from destroying the CertificateAuthority. This parameter is required.
        Returns:
        this

      • desiredState

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder desiredState​(String desiredState)
        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}

        Parameters:
        desiredState - Desired state of the CertificateAuthority. Set this field to 'STAGED' to create a 'STAGED' root CA. This parameter is required.
        Returns:
        this

      • gcsBucket

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder gcsBucket​(String gcsBucket)
        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}

        Parameters:
        gcsBucket - The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#id PrivatecaCertificateAuthority#id}. This parameter is required.
        Returns:
        this

      • ignoreActiveCertificatesOnDeletion

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder ignoreActiveCertificatesOnDeletion​(Boolean ignoreActiveCertificatesOnDeletion)
        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}

        Parameters:
        ignoreActiveCertificatesOnDeletion - This field allows the CA to be deleted even if the CA has active certs. This parameter is required.
        Returns:
        this

      • ignoreActiveCertificatesOnDeletion

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder ignoreActiveCertificatesOnDeletion​(com.hashicorp.cdktf.IResolvable ignoreActiveCertificatesOnDeletion)
        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}

        Parameters:
        ignoreActiveCertificatesOnDeletion - This field allows the CA to be deleted even if the CA has active certs. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder labels​(Map<String,​String> labels)
        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}

        Parameters:
        labels - Labels with user-defined metadata. This parameter is required.
        Returns:
        this

      • lifetime

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder lifetime​(String lifetime)
        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}

        Parameters:
        lifetime - The desired lifetime of the CA certificate. This parameter is required.
        Returns:
        this

      • pemCaCertificate

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder pemCaCertificate​(String pemCaCertificate)
        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}

        Parameters:
        pemCaCertificate - The signed CA certificate issued from the subordinated CA's CSR. This parameter is required.
        Returns:
        this

      • project

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

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/privateca_certificate_authority#project PrivatecaCertificateAuthority#project}. This parameter is required.
        Returns:
        this

      • skipGracePeriod

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder skipGracePeriod​(Boolean skipGracePeriod)
        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}

        Parameters:
        skipGracePeriod - 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. This parameter is required.
        Returns:
        this

      • skipGracePeriod

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder skipGracePeriod​(com.hashicorp.cdktf.IResolvable skipGracePeriod)
        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}

        Parameters:
        skipGracePeriod - 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. This parameter is required.
        Returns:
        this

      • subordinateConfig

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder subordinateConfig​(PrivatecaCertificateAuthoritySubordinateConfig subordinateConfig)
        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}

        Parameters:
        subordinateConfig - subordinate_config block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder timeouts​(PrivatecaCertificateAuthorityTimeouts timeouts)
        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}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public PrivatecaCertificateAuthority.Builder type​(String type)
        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}

        Parameters:
        type - The Type of this CertificateAuthority. This parameter is required.
        Returns:
        this