Skip to content

network.v1beta1.vpnGatewayConnection

"VPNGatewayConnection is the Schema for the VPNGatewayConnections API. Manages a VPN Gateway Connection."

Index

Fields

fn new

new(name)

new returns an instance of VPNGatewayConnection

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"

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

"VPNGatewayConnectionSpec defines the desired state of VPNGatewayConnection"

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."

obj spec.forProvider

fn spec.forProvider.withInternetSecurityEnabled

withInternetSecurityEnabled(internetSecurityEnabled)

"Whether Internet Security is enabled for this VPN Connection. Defaults to false."

fn spec.forProvider.withRemoteVpnSiteId

withRemoteVpnSiteId(remoteVpnSiteId)

"The ID of the remote VPN Site, which will connect to the VPN Gateway. Changing this forces a new VPN Gateway Connection to be created."

fn spec.forProvider.withRouting

withRouting(routing)

"A routing block as defined below. If this is not specified, there will be a default route table created implicitly."

fn spec.forProvider.withRoutingMixin

withRoutingMixin(routing)

"A routing block as defined below. If this is not specified, there will be a default route table created implicitly."

Note: This function appends passed data to existing values

fn spec.forProvider.withTrafficSelectorPolicy

withTrafficSelectorPolicy(trafficSelectorPolicy)

"One or more traffic_selector_policy blocks as defined below."

fn spec.forProvider.withTrafficSelectorPolicyMixin

withTrafficSelectorPolicyMixin(trafficSelectorPolicy)

"One or more traffic_selector_policy blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withVpnGatewayId

withVpnGatewayId(vpnGatewayId)

"The ID of the VPN Gateway that this VPN Gateway Connection belongs to. Changing this forces a new VPN Gateway Connection to be created."

withVpnLink(vpnLink)

"One or more vpn_link blocks as defined below."

fn spec.forProvider.withVpnLinkMixin

withVpnLinkMixin(vpnLink)

"One or more vpn_link blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.remoteVpnSiteIdRef

"Reference to a VPNSite in network to populate remoteVpnSiteId."

fn spec.forProvider.remoteVpnSiteIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.remoteVpnSiteIdRef.policy

"Policies for referencing."

fn spec.forProvider.remoteVpnSiteIdRef.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.remoteVpnSiteIdRef.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.remoteVpnSiteIdSelector

"Selector for a VPNSite in network to populate remoteVpnSiteId."

fn spec.forProvider.remoteVpnSiteIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.remoteVpnSiteIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.remoteVpnSiteIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.remoteVpnSiteIdSelector.policy

"Policies for selection."

fn spec.forProvider.remoteVpnSiteIdSelector.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.remoteVpnSiteIdSelector.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.routing

"A routing block as defined below. If this is not specified, there will be a default route table created implicitly."

fn spec.forProvider.routing.withAssociatedRouteTable

withAssociatedRouteTable(associatedRouteTable)

"The ID of the Route Table associated with this VPN Connection."

fn spec.forProvider.routing.withInboundRouteMapId

withInboundRouteMapId(inboundRouteMapId)

"The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes."

fn spec.forProvider.routing.withOutboundRouteMapId

withOutboundRouteMapId(outboundRouteMapId)

"The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes."

fn spec.forProvider.routing.withPropagatedRouteTable

withPropagatedRouteTable(propagatedRouteTable)

"A propagated_route_table block as defined below."

fn spec.forProvider.routing.withPropagatedRouteTableMixin

withPropagatedRouteTableMixin(propagatedRouteTable)

"A propagated_route_table block as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.routing.propagatedRouteTable

"A propagated_route_table block as defined below."

fn spec.forProvider.routing.propagatedRouteTable.withLabels

withLabels(labels)

"A list of labels to assign to this route table."

fn spec.forProvider.routing.propagatedRouteTable.withLabelsMixin

withLabelsMixin(labels)

"A list of labels to assign to this route table."

Note: This function appends passed data to existing values

fn spec.forProvider.routing.propagatedRouteTable.withRouteTableIds

withRouteTableIds(routeTableIds)

"A list of Route Table IDs to associated with this VPN Gateway Connection."

fn spec.forProvider.routing.propagatedRouteTable.withRouteTableIdsMixin

withRouteTableIdsMixin(routeTableIds)

"A list of Route Table IDs to associated with this VPN Gateway Connection."

Note: This function appends passed data to existing values

obj spec.forProvider.trafficSelectorPolicy

"One or more traffic_selector_policy blocks as defined below."

fn spec.forProvider.trafficSelectorPolicy.withLocalAddressRanges

withLocalAddressRanges(localAddressRanges)

"A list of local address spaces in CIDR format for this VPN Gateway Connection."

fn spec.forProvider.trafficSelectorPolicy.withLocalAddressRangesMixin

withLocalAddressRangesMixin(localAddressRanges)

"A list of local address spaces in CIDR format for this VPN Gateway Connection."

Note: This function appends passed data to existing values

fn spec.forProvider.trafficSelectorPolicy.withRemoteAddressRanges

withRemoteAddressRanges(remoteAddressRanges)

"A list of remote address spaces in CIDR format for this VPN Gateway Connection."

fn spec.forProvider.trafficSelectorPolicy.withRemoteAddressRangesMixin

withRemoteAddressRangesMixin(remoteAddressRanges)

"A list of remote address spaces in CIDR format for this VPN Gateway Connection."

Note: This function appends passed data to existing values

obj spec.forProvider.vpnGatewayIdRef

"Reference to a VPNGateway in network to populate vpnGatewayId."

fn spec.forProvider.vpnGatewayIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.vpnGatewayIdRef.policy

"Policies for referencing."

fn spec.forProvider.vpnGatewayIdRef.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.vpnGatewayIdRef.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.vpnGatewayIdSelector

"Selector for a VPNGateway in network to populate vpnGatewayId."

fn spec.forProvider.vpnGatewayIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.vpnGatewayIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.vpnGatewayIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.vpnGatewayIdSelector.policy

"Policies for selection."

fn spec.forProvider.vpnGatewayIdSelector.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.vpnGatewayIdSelector.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."

"One or more vpn_link blocks as defined below."

fn spec.forProvider.vpnLink.withBandwidthMbps

withBandwidthMbps(bandwidthMbps)

"The expected connection bandwidth in MBPS. Defaults to 10."

fn spec.forProvider.vpnLink.withBgpEnabled

withBgpEnabled(bgpEnabled)

"Should the BGP be enabled? Defaults to false. Changing this forces a new VPN Gateway Connection to be created."

fn spec.forProvider.vpnLink.withConnectionMode

withConnectionMode(connectionMode)

"The connection mode of this VPN Link. Possible values are Default, InitiatorOnly and ResponderOnly. Defaults to Default."

fn spec.forProvider.vpnLink.withCustomBgpAddress

withCustomBgpAddress(customBgpAddress)

"One or more custom_bgp_address blocks as defined below."

fn spec.forProvider.vpnLink.withCustomBgpAddressMixin

withCustomBgpAddressMixin(customBgpAddress)

"One or more custom_bgp_address blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.vpnLink.withEgressNatRuleIds

withEgressNatRuleIds(egressNatRuleIds)

"A list of the egress NAT Rule Ids."

fn spec.forProvider.vpnLink.withEgressNatRuleIdsMixin

withEgressNatRuleIdsMixin(egressNatRuleIds)

"A list of the egress NAT Rule Ids."

Note: This function appends passed data to existing values

fn spec.forProvider.vpnLink.withIngressNatRuleIds

withIngressNatRuleIds(ingressNatRuleIds)

"A list of the ingress NAT Rule Ids."

fn spec.forProvider.vpnLink.withIngressNatRuleIdsMixin

withIngressNatRuleIdsMixin(ingressNatRuleIds)

"A list of the ingress NAT Rule Ids."

Note: This function appends passed data to existing values

fn spec.forProvider.vpnLink.withIpsecPolicy

withIpsecPolicy(ipsecPolicy)

"One or more ipsec_policy blocks as defined above."

fn spec.forProvider.vpnLink.withIpsecPolicyMixin

withIpsecPolicyMixin(ipsecPolicy)

"One or more ipsec_policy blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.vpnLink.withLocalAzureIpAddressEnabled

withLocalAzureIpAddressEnabled(localAzureIpAddressEnabled)

"Whether to use local Azure IP to initiate connection? Defaults to false."

fn spec.forProvider.vpnLink.withName

withName(name)

"The name which should be used for this VPN Link Connection."

fn spec.forProvider.vpnLink.withPolicyBasedTrafficSelectorEnabled

withPolicyBasedTrafficSelectorEnabled(policyBasedTrafficSelectorEnabled)

"Whether to enable policy-based traffic selectors? Defaults to false."

fn spec.forProvider.vpnLink.withProtocol

withProtocol(protocol)

"The protocol used for this VPN Link Connection. Possible values are IKEv1 and IKEv2. Defaults to IKEv2."

fn spec.forProvider.vpnLink.withRatelimitEnabled

withRatelimitEnabled(ratelimitEnabled)

"Should the rate limit be enabled? Defaults to false."

fn spec.forProvider.vpnLink.withRouteWeight

withRouteWeight(routeWeight)

"Routing weight for this VPN Link Connection. Defaults to 0."

fn spec.forProvider.vpnLink.withSharedKey

withSharedKey(sharedKey)

"SharedKey for this VPN Link Connection."

fn spec.forProvider.vpnLink.withVpnSiteLinkId

withVpnSiteLinkId(vpnSiteLinkId)

"The ID of the connected VPN Site Link. Changing this forces a new VPN Gateway Connection to be created."

obj spec.forProvider.vpnLink.customBgpAddress

"One or more custom_bgp_address blocks as defined below."

fn spec.forProvider.vpnLink.customBgpAddress.withIpAddress

withIpAddress(ipAddress)

"The custom bgp ip address which belongs to the IP Configuration."

fn spec.forProvider.vpnLink.customBgpAddress.withIpConfigurationId

withIpConfigurationId(ipConfigurationId)

"The ID of the IP Configuration which belongs to the VPN Gateway."

obj spec.forProvider.vpnLink.ipsecPolicy

"One or more ipsec_policy blocks as defined above."

fn spec.forProvider.vpnLink.ipsecPolicy.withDhGroup

withDhGroup(dhGroup)

"The DH Group used in IKE Phase 1 for initial SA. Possible values are None, DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384."

fn spec.forProvider.vpnLink.ipsecPolicy.withEncryptionAlgorithm

withEncryptionAlgorithm(encryptionAlgorithm)

"The IPSec encryption algorithm (IKE phase 1). Possible values are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, None."

fn spec.forProvider.vpnLink.ipsecPolicy.withIkeEncryptionAlgorithm

withIkeEncryptionAlgorithm(ikeEncryptionAlgorithm)

"The IKE encryption algorithm (IKE phase 2). Possible values are DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES256."

fn spec.forProvider.vpnLink.ipsecPolicy.withIkeIntegrityAlgorithm

withIkeIntegrityAlgorithm(ikeIntegrityAlgorithm)

"The IKE integrity algorithm (IKE phase 2). Possible values are MD5, SHA1, SHA256, SHA384, GCMAES128, GCMAES256."

fn spec.forProvider.vpnLink.ipsecPolicy.withIntegrityAlgorithm

withIntegrityAlgorithm(integrityAlgorithm)

"The IPSec integrity algorithm (IKE phase 1). Possible values are MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256."

fn spec.forProvider.vpnLink.ipsecPolicy.withPfsGroup

withPfsGroup(pfsGroup)

"The Pfs Group used in IKE Phase 2 for the new child SA. Possible values are None, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM, ECP256, ECP384."

fn spec.forProvider.vpnLink.ipsecPolicy.withSaDataSizeKb

withSaDataSizeKb(saDataSizeKb)

"The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for the site to site VPN tunnel."

fn spec.forProvider.vpnLink.ipsecPolicy.withSaLifetimeSec

withSaLifetimeSec(saLifetimeSec)

"The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for the site to site VPN tunnel."

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."