Skip to content

network.v1beta1.vpnServerConfiguration

"VPNServerConfiguration is the Schema for the VPNServerConfigurations API. Manages a VPN Server Configuration."

Index

Fields

fn new

new(name)

new returns an instance of VPNServerConfiguration

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

"VPNServerConfigurationSpec defines the desired state of VPNServerConfiguration"

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

withAzureActiveDirectoryAuthentication(azureActiveDirectoryAuthentication)

"A azure_active_directory_authentication block as defined below."

fn spec.forProvider.withAzureActiveDirectoryAuthenticationMixin

withAzureActiveDirectoryAuthenticationMixin(azureActiveDirectoryAuthentication)

"A azure_active_directory_authentication block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withClientRevokedCertificate

withClientRevokedCertificate(clientRevokedCertificate)

"One or more client_revoked_certificate blocks as defined below."

fn spec.forProvider.withClientRevokedCertificateMixin

withClientRevokedCertificateMixin(clientRevokedCertificate)

"One or more client_revoked_certificate blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withClientRootCertificate

withClientRootCertificate(clientRootCertificate)

"One or more client_root_certificate blocks as defined below."

fn spec.forProvider.withClientRootCertificateMixin

withClientRootCertificateMixin(clientRootCertificate)

"One or more client_root_certificate blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIpsecPolicy

withIpsecPolicy(ipsecPolicy)

"A ipsec_policy block as defined below."

fn spec.forProvider.withIpsecPolicyMixin

withIpsecPolicyMixin(ipsecPolicy)

"A ipsec_policy block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLocation

withLocation(location)

"The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created."

fn spec.forProvider.withRadius

withRadius(radius)

"A radius block as defined below."

fn spec.forProvider.withRadiusMixin

withRadiusMixin(radius)

"A radius block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created."

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags to assign to the resource."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags to assign to the resource."

Note: This function appends passed data to existing values

fn spec.forProvider.withVpnAuthenticationTypes

withVpnAuthenticationTypes(vpnAuthenticationTypes)

"A list of Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius."

fn spec.forProvider.withVpnAuthenticationTypesMixin

withVpnAuthenticationTypesMixin(vpnAuthenticationTypes)

"A list of Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius."

Note: This function appends passed data to existing values

fn spec.forProvider.withVpnProtocols

withVpnProtocols(vpnProtocols)

"A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN."

fn spec.forProvider.withVpnProtocolsMixin

withVpnProtocolsMixin(vpnProtocols)

"A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN."

Note: This function appends passed data to existing values

obj spec.forProvider.azureActiveDirectoryAuthentication

"A azure_active_directory_authentication block as defined below."

fn spec.forProvider.azureActiveDirectoryAuthentication.withAudience

withAudience(audience)

"The Audience which should be used for authentication."

fn spec.forProvider.azureActiveDirectoryAuthentication.withIssuer

withIssuer(issuer)

"The Issuer which should be used for authentication."

fn spec.forProvider.azureActiveDirectoryAuthentication.withTenant

withTenant(tenant)

"The Tenant which should be used for authentication."

obj spec.forProvider.clientRevokedCertificate

"One or more client_revoked_certificate blocks as defined below."

fn spec.forProvider.clientRevokedCertificate.withName

withName(name)

"A name used to uniquely identify this certificate."

fn spec.forProvider.clientRevokedCertificate.withThumbprint

withThumbprint(thumbprint)

"The Thumbprint of the Certificate."

obj spec.forProvider.clientRootCertificate

"One or more client_root_certificate blocks as defined below."

fn spec.forProvider.clientRootCertificate.withName

withName(name)

"A name used to uniquely identify this certificate."

fn spec.forProvider.clientRootCertificate.withPublicCertData

withPublicCertData(publicCertData)

"The Public Key Data associated with the Certificate."

obj spec.forProvider.ipsecPolicy

"A ipsec_policy block as defined below."

fn spec.forProvider.ipsecPolicy.withDhGroup

withDhGroup(dhGroup)

"The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None."

fn spec.forProvider.ipsecPolicy.withIkeEncryption

withIkeEncryption(ikeEncryption)

"The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256."

fn spec.forProvider.ipsecPolicy.withIkeIntegrity

withIkeIntegrity(ikeIntegrity)

"The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384."

fn spec.forProvider.ipsecPolicy.withIpsecEncryption

withIpsecEncryption(ipsecEncryption)

"The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None."

fn spec.forProvider.ipsecPolicy.withIpsecIntegrity

withIpsecIntegrity(ipsecIntegrity)

"The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256."

fn spec.forProvider.ipsecPolicy.withPfsGroup

withPfsGroup(pfsGroup)

"The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None."

fn spec.forProvider.ipsecPolicy.withSaDataSizeKilobytes

withSaDataSizeKilobytes(saDataSizeKilobytes)

"The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel."

fn spec.forProvider.ipsecPolicy.withSaLifetimeSeconds

withSaLifetimeSeconds(saLifetimeSeconds)

"The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel."

obj spec.forProvider.radius

"A radius block as defined below."

fn spec.forProvider.radius.withClientRootCertificate

withClientRootCertificate(clientRootCertificate)

"One or more client_root_certificate blocks as defined above."

fn spec.forProvider.radius.withClientRootCertificateMixin

withClientRootCertificateMixin(clientRootCertificate)

"One or more client_root_certificate blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.radius.withServer

withServer(server)

"One or more server blocks as defined below."

fn spec.forProvider.radius.withServerMixin

withServerMixin(server)

"One or more server blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.radius.withServerRootCertificate

withServerRootCertificate(serverRootCertificate)

"One or more server_root_certificate blocks as defined below."

fn spec.forProvider.radius.withServerRootCertificateMixin

withServerRootCertificateMixin(serverRootCertificate)

"One or more server_root_certificate blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.radius.clientRootCertificate

"One or more client_root_certificate blocks as defined above."

fn spec.forProvider.radius.clientRootCertificate.withName

withName(name)

"A name used to uniquely identify this certificate."

fn spec.forProvider.radius.clientRootCertificate.withThumbprint

withThumbprint(thumbprint)

"The Thumbprint of the Certificate."

obj spec.forProvider.radius.server

"One or more server blocks as defined below."

fn spec.forProvider.radius.server.withAddress

withAddress(address)

"The Address of the Radius Server."

fn spec.forProvider.radius.server.withScore

withScore(score)

"The Score of the Radius Server determines the priority of the server. Ranges from 1 to 30."

obj spec.forProvider.radius.server.secretSecretRef

"The Secret used to communicate with the Radius Server."

fn spec.forProvider.radius.server.secretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.radius.server.secretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.radius.server.secretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.radius.serverRootCertificate

"One or more server_root_certificate blocks as defined below."

fn spec.forProvider.radius.serverRootCertificate.withName

withName(name)

"A name used to uniquely identify this certificate."

fn spec.forProvider.radius.serverRootCertificate.withPublicCertData

withPublicCertData(publicCertData)

"The Public Key Data associated with the Certificate."

obj spec.forProvider.resourceGroupNameRef

"Reference to a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.resourceGroupNameRef.policy

"Policies for referencing."

fn spec.forProvider.resourceGroupNameRef.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.resourceGroupNameRef.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.resourceGroupNameSelector

"Selector for a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.resourceGroupNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.resourceGroupNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.resourceGroupNameSelector.policy

"Policies for selection."

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