dns.v1beta1.managedZone
"ManagedZone is the Schema for the ManagedZones API. A zone is a subtree of the DNS namespace under one administrative responsibility."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
fn withManagementPolicies(managementPolicies)
fn withManagementPoliciesMixin(managementPolicies)
obj spec.forProvider
fn withCloudLoggingConfig(cloudLoggingConfig)
fn withCloudLoggingConfigMixin(cloudLoggingConfig)
fn withDescription(description)
fn withDnsName(dnsName)
fn withDnssecConfig(dnssecConfig)
fn withDnssecConfigMixin(dnssecConfig)
fn withForceDestroy(forceDestroy)
fn withForwardingConfig(forwardingConfig)
fn withForwardingConfigMixin(forwardingConfig)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withPeeringConfig(peeringConfig)
fn withPeeringConfigMixin(peeringConfig)
fn withPrivateVisibilityConfig(privateVisibilityConfig)
fn withPrivateVisibilityConfigMixin(privateVisibilityConfig)
fn withProject(project)
fn withVisibility(visibility)
obj spec.forProvider.cloudLoggingConfig
obj spec.forProvider.dnssecConfig
obj spec.forProvider.forwardingConfig
obj spec.forProvider.peeringConfig
obj spec.forProvider.privateVisibilityConfig
fn withGkeClusters(gkeClusters)
fn withGkeClustersMixin(gkeClusters)
fn withNetworks(networks)
fn withNetworksMixin(networks)
obj spec.forProvider.privateVisibilityConfig.gkeClusters
obj spec.forProvider.privateVisibilityConfig.networks
obj spec.initProvider
fn withCloudLoggingConfig(cloudLoggingConfig)
fn withCloudLoggingConfigMixin(cloudLoggingConfig)
fn withDescription(description)
fn withDnsName(dnsName)
fn withDnssecConfig(dnssecConfig)
fn withDnssecConfigMixin(dnssecConfig)
fn withForceDestroy(forceDestroy)
fn withForwardingConfig(forwardingConfig)
fn withForwardingConfigMixin(forwardingConfig)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withPeeringConfig(peeringConfig)
fn withPeeringConfigMixin(peeringConfig)
fn withPrivateVisibilityConfig(privateVisibilityConfig)
fn withPrivateVisibilityConfigMixin(privateVisibilityConfig)
fn withProject(project)
fn withVisibility(visibility)
obj spec.initProvider.cloudLoggingConfig
obj spec.initProvider.dnssecConfig
obj spec.initProvider.forwardingConfig
obj spec.initProvider.peeringConfig
obj spec.initProvider.privateVisibilityConfig
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of ManagedZone
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"ManagedZoneSpec defines the desired state of ManagedZone"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withCloudLoggingConfig
withCloudLoggingConfig(cloudLoggingConfig)
"Cloud logging configuration Structure is documented below."
fn spec.forProvider.withCloudLoggingConfigMixin
withCloudLoggingConfigMixin(cloudLoggingConfig)
"Cloud logging configuration Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDescription
withDescription(description)
"A textual description field."
fn spec.forProvider.withDnsName
withDnsName(dnsName)
"The DNS name of this managed zone, for instance \"example.com.\"."
fn spec.forProvider.withDnssecConfig
withDnssecConfig(dnssecConfig)
"DNSSEC configuration Structure is documented below."
fn spec.forProvider.withDnssecConfigMixin
withDnssecConfigMixin(dnssecConfig)
"DNSSEC configuration Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withForceDestroy
withForceDestroy(forceDestroy)
"Set this true to delete all records in the zone."
fn spec.forProvider.withForwardingConfig
withForwardingConfig(forwardingConfig)
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
fn spec.forProvider.withForwardingConfigMixin
withForwardingConfigMixin(forwardingConfig)
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withLabels
withLabels(labels)
"A set of key/value label pairs to assign to this ManagedZone."
fn spec.forProvider.withLabelsMixin
withLabelsMixin(labels)
"A set of key/value label pairs to assign to this ManagedZone."
Note: This function appends passed data to existing values
fn spec.forProvider.withPeeringConfig
withPeeringConfig(peeringConfig)
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
fn spec.forProvider.withPeeringConfigMixin
withPeeringConfigMixin(peeringConfig)
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withPrivateVisibilityConfig
withPrivateVisibilityConfig(privateVisibilityConfig)
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
fn spec.forProvider.withPrivateVisibilityConfigMixin
withPrivateVisibilityConfigMixin(privateVisibilityConfig)
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.forProvider.withVisibility
withVisibility(visibility)
"The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. Default value is public. Possible values are: private, public."
obj spec.forProvider.cloudLoggingConfig
"Cloud logging configuration Structure is documented below."
fn spec.forProvider.cloudLoggingConfig.withEnableLogging
withEnableLogging(enableLogging)
"If set, enable query logging for this ManagedZone. False by default, making logging opt-in."
obj spec.forProvider.dnssecConfig
"DNSSEC configuration Structure is documented below."
fn spec.forProvider.dnssecConfig.withDefaultKeySpecs
withDefaultKeySpecs(defaultKeySpecs)
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
fn spec.forProvider.dnssecConfig.withDefaultKeySpecsMixin
withDefaultKeySpecsMixin(defaultKeySpecs)
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.dnssecConfig.withKind
withKind(kind)
"Identifies what kind of resource this is"
fn spec.forProvider.dnssecConfig.withNonExistence
withNonExistence(nonExistence)
"Specifies the mechanism used to provide authenticated denial-of-existence responses. non_existence can only be updated when the state is off. Possible values are: nsec, nsec3."
fn spec.forProvider.dnssecConfig.withState
withState(state)
"Specifies whether DNSSEC is enabled, and what mode it is in Possible values are: off, on, transfer."
obj spec.forProvider.dnssecConfig.defaultKeySpecs
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
fn spec.forProvider.dnssecConfig.defaultKeySpecs.withAlgorithm
withAlgorithm(algorithm)
"String mnemonic specifying the DNSSEC algorithm of this key Possible values are: ecdsap256sha256, ecdsap384sha384, rsasha1, rsasha256, rsasha512."
fn spec.forProvider.dnssecConfig.defaultKeySpecs.withKeyLength
withKeyLength(keyLength)
"Length of the keys in bits"
fn spec.forProvider.dnssecConfig.defaultKeySpecs.withKeyType
withKeyType(keyType)
"Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. Possible values are: keySigning, zoneSigning."
fn spec.forProvider.dnssecConfig.defaultKeySpecs.withKind
withKind(kind)
"Identifies what kind of resource this is"
obj spec.forProvider.forwardingConfig
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
fn spec.forProvider.forwardingConfig.withTargetNameServers
withTargetNameServers(targetNameServers)
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
fn spec.forProvider.forwardingConfig.withTargetNameServersMixin
withTargetNameServersMixin(targetNameServers)
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.forwardingConfig.targetNameServers
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
fn spec.forProvider.forwardingConfig.targetNameServers.withForwardingPath
withForwardingPath(forwardingPath)
"Forwarding path for this TargetNameServer. If unset or default Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to private, Cloud DNS will always send queries through VPC for this target Possible values are: default, private."
fn spec.forProvider.forwardingConfig.targetNameServers.withIpv4Address
withIpv4Address(ipv4Address)
"IPv4 address of a target name server."
obj spec.forProvider.peeringConfig
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
fn spec.forProvider.peeringConfig.withTargetNetwork
withTargetNetwork(targetNetwork)
"The network with which to peer. Structure is documented below."
fn spec.forProvider.peeringConfig.withTargetNetworkMixin
withTargetNetworkMixin(targetNetwork)
"The network with which to peer. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.peeringConfig.targetNetwork
"The network with which to peer. Structure is documented below."
fn spec.forProvider.peeringConfig.targetNetwork.withNetworkUrl
withNetworkUrl(networkUrl)
"The id or fully qualified URL of the VPC network to forward queries to. This should be formatted like projects/{project}/global/networks/{network} or https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}"
obj spec.forProvider.peeringConfig.targetNetwork.networkUrlRef
"Reference to a Network in compute to populate networkUrl."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.peeringConfig.targetNetwork.networkUrlRef.policy
"Policies for referencing."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector
"Selector for a Network in compute to populate networkUrl."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.policy
"Policies for selection."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.peeringConfig.targetNetwork.networkUrlSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.privateVisibilityConfig
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
fn spec.forProvider.privateVisibilityConfig.withGkeClusters
withGkeClusters(gkeClusters)
"The list of Google Kubernetes Engine clusters that can see this zone. Structure is documented below."
fn spec.forProvider.privateVisibilityConfig.withGkeClustersMixin
withGkeClustersMixin(gkeClusters)
"The list of Google Kubernetes Engine clusters that can see this zone. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.privateVisibilityConfig.withNetworks
withNetworks(networks)
"The list of VPC networks that can see this zone.12 SDK in a future release, you may experience issues with this resource while updating. If you encounter this issue, remove all networks blocks in an update and then apply another update adding all of them back simultaneously. Structure is documented below."
fn spec.forProvider.privateVisibilityConfig.withNetworksMixin
withNetworksMixin(networks)
"The list of VPC networks that can see this zone.12 SDK in a future release, you may experience issues with this resource while updating. If you encounter this issue, remove all networks blocks in an update and then apply another update adding all of them back simultaneously. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.privateVisibilityConfig.gkeClusters
"The list of Google Kubernetes Engine clusters that can see this zone. Structure is documented below."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.withGkeClusterName
withGkeClusterName(gkeClusterName)
"The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like projects//locations//clusters/*"
obj spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameRef
"Reference to a Cluster in container to populate gkeClusterName."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameRef.policy
"Policies for referencing."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector
"Selector for a Cluster in container to populate gkeClusterName."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.policy
"Policies for selection."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateVisibilityConfig.gkeClusters.gkeClusterNameSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.privateVisibilityConfig.networks
"The list of VPC networks that can see this zone.12 SDK in a future release, you may experience issues with this resource while updating. If you encounter this issue, remove all networks blocks in an update and then apply another update adding all of them back simultaneously. Structure is documented below."
fn spec.forProvider.privateVisibilityConfig.networks.withNetworkUrl
withNetworkUrl(networkUrl)
"The id or fully qualified URL of the VPC network to forward queries to. This should be formatted like projects/{project}/global/networks/{network} or https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}"
obj spec.forProvider.privateVisibilityConfig.networks.networkUrlRef
"Reference to a Network in compute to populate networkUrl."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.privateVisibilityConfig.networks.networkUrlRef.policy
"Policies for referencing."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector
"Selector for a Network in compute to populate networkUrl."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.policy
"Policies for selection."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateVisibilityConfig.networks.networkUrlSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."
fn spec.initProvider.withCloudLoggingConfig
withCloudLoggingConfig(cloudLoggingConfig)
"Cloud logging configuration Structure is documented below."
fn spec.initProvider.withCloudLoggingConfigMixin
withCloudLoggingConfigMixin(cloudLoggingConfig)
"Cloud logging configuration Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withDescription
withDescription(description)
"A textual description field."
fn spec.initProvider.withDnsName
withDnsName(dnsName)
"The DNS name of this managed zone, for instance \"example.com.\"."
fn spec.initProvider.withDnssecConfig
withDnssecConfig(dnssecConfig)
"DNSSEC configuration Structure is documented below."
fn spec.initProvider.withDnssecConfigMixin
withDnssecConfigMixin(dnssecConfig)
"DNSSEC configuration Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withForceDestroy
withForceDestroy(forceDestroy)
"Set this true to delete all records in the zone."
fn spec.initProvider.withForwardingConfig
withForwardingConfig(forwardingConfig)
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
fn spec.initProvider.withForwardingConfigMixin
withForwardingConfigMixin(forwardingConfig)
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withLabels
withLabels(labels)
"A set of key/value label pairs to assign to this ManagedZone."
fn spec.initProvider.withLabelsMixin
withLabelsMixin(labels)
"A set of key/value label pairs to assign to this ManagedZone."
Note: This function appends passed data to existing values
fn spec.initProvider.withPeeringConfig
withPeeringConfig(peeringConfig)
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
fn spec.initProvider.withPeeringConfigMixin
withPeeringConfigMixin(peeringConfig)
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withPrivateVisibilityConfig
withPrivateVisibilityConfig(privateVisibilityConfig)
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
fn spec.initProvider.withPrivateVisibilityConfigMixin
withPrivateVisibilityConfigMixin(privateVisibilityConfig)
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.initProvider.withVisibility
withVisibility(visibility)
"The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. Default value is public. Possible values are: private, public."
obj spec.initProvider.cloudLoggingConfig
"Cloud logging configuration Structure is documented below."
fn spec.initProvider.cloudLoggingConfig.withEnableLogging
withEnableLogging(enableLogging)
"If set, enable query logging for this ManagedZone. False by default, making logging opt-in."
obj spec.initProvider.dnssecConfig
"DNSSEC configuration Structure is documented below."
fn spec.initProvider.dnssecConfig.withDefaultKeySpecs
withDefaultKeySpecs(defaultKeySpecs)
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
fn spec.initProvider.dnssecConfig.withDefaultKeySpecsMixin
withDefaultKeySpecsMixin(defaultKeySpecs)
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.dnssecConfig.withKind
withKind(kind)
"Identifies what kind of resource this is"
fn spec.initProvider.dnssecConfig.withNonExistence
withNonExistence(nonExistence)
"Specifies the mechanism used to provide authenticated denial-of-existence responses. non_existence can only be updated when the state is off. Possible values are: nsec, nsec3."
fn spec.initProvider.dnssecConfig.withState
withState(state)
"Specifies whether DNSSEC is enabled, and what mode it is in Possible values are: off, on, transfer."
obj spec.initProvider.dnssecConfig.defaultKeySpecs
"Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is off. Structure is documented below."
fn spec.initProvider.dnssecConfig.defaultKeySpecs.withAlgorithm
withAlgorithm(algorithm)
"String mnemonic specifying the DNSSEC algorithm of this key Possible values are: ecdsap256sha256, ecdsap384sha384, rsasha1, rsasha256, rsasha512."
fn spec.initProvider.dnssecConfig.defaultKeySpecs.withKeyLength
withKeyLength(keyLength)
"Length of the keys in bits"
fn spec.initProvider.dnssecConfig.defaultKeySpecs.withKeyType
withKeyType(keyType)
"Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. Possible values are: keySigning, zoneSigning."
fn spec.initProvider.dnssecConfig.defaultKeySpecs.withKind
withKind(kind)
"Identifies what kind of resource this is"
obj spec.initProvider.forwardingConfig
"The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Structure is documented below."
fn spec.initProvider.forwardingConfig.withTargetNameServers
withTargetNameServers(targetNameServers)
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
fn spec.initProvider.forwardingConfig.withTargetNameServersMixin
withTargetNameServersMixin(targetNameServers)
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.forwardingConfig.targetNameServers
"List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Structure is documented below."
fn spec.initProvider.forwardingConfig.targetNameServers.withForwardingPath
withForwardingPath(forwardingPath)
"Forwarding path for this TargetNameServer. If unset or default Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to private, Cloud DNS will always send queries through VPC for this target Possible values are: default, private."
fn spec.initProvider.forwardingConfig.targetNameServers.withIpv4Address
withIpv4Address(ipv4Address)
"IPv4 address of a target name server."
obj spec.initProvider.peeringConfig
"The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Structure is documented below."
fn spec.initProvider.peeringConfig.withTargetNetwork
withTargetNetwork(targetNetwork)
"The network with which to peer. Structure is documented below."
fn spec.initProvider.peeringConfig.withTargetNetworkMixin
withTargetNetworkMixin(targetNetwork)
"The network with which to peer. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.privateVisibilityConfig
"For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Structure is documented below."
fn spec.initProvider.privateVisibilityConfig.withGkeClusters
withGkeClusters(gkeClusters)
"The list of Google Kubernetes Engine clusters that can see this zone. Structure is documented below."
fn spec.initProvider.privateVisibilityConfig.withGkeClustersMixin
withGkeClustersMixin(gkeClusters)
"The list of Google Kubernetes Engine clusters that can see this zone. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.privateVisibilityConfig.withNetworks
withNetworks(networks)
"The list of VPC networks that can see this zone.12 SDK in a future release, you may experience issues with this resource while updating. If you encounter this issue, remove all networks blocks in an update and then apply another update adding all of them back simultaneously. Structure is documented below."
fn spec.initProvider.privateVisibilityConfig.withNetworksMixin
withNetworksMixin(networks)
"The list of VPC networks that can see this zone.12 SDK in a future release, you may experience issues with this resource while updating. If you encounter this issue, remove all networks blocks in an update and then apply another update adding all of them back simultaneously. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."