servicefabric.v1beta1.cluster
"Cluster is the Schema for the Clusters API. Manages a Service Fabric Cluster."
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)
obj spec.forProvider
fn withAddOnFeatures(addOnFeatures)
fn withAddOnFeaturesMixin(addOnFeatures)
fn withAzureActiveDirectory(azureActiveDirectory)
fn withAzureActiveDirectoryMixin(azureActiveDirectory)
fn withCertificate(certificate)
fn withCertificateCommonNames(certificateCommonNames)
fn withCertificateCommonNamesMixin(certificateCommonNames)
fn withCertificateMixin(certificate)
fn withClientCertificateCommonName(clientCertificateCommonName)
fn withClientCertificateCommonNameMixin(clientCertificateCommonName)
fn withClientCertificateThumbprint(clientCertificateThumbprint)
fn withClientCertificateThumbprintMixin(clientCertificateThumbprint)
fn withClusterCodeVersion(clusterCodeVersion)
fn withDiagnosticsConfig(diagnosticsConfig)
fn withDiagnosticsConfigMixin(diagnosticsConfig)
fn withFabricSettings(fabricSettings)
fn withFabricSettingsMixin(fabricSettings)
fn withLocation(location)
fn withManagementEndpoint(managementEndpoint)
fn withNodeType(nodeType)
fn withNodeTypeMixin(nodeType)
fn withReliabilityLevel(reliabilityLevel)
fn withResourceGroupName(resourceGroupName)
fn withReverseProxyCertificate(reverseProxyCertificate)
fn withReverseProxyCertificateCommonNames(reverseProxyCertificateCommonNames)
fn withReverseProxyCertificateCommonNamesMixin(reverseProxyCertificateCommonNames)
fn withReverseProxyCertificateMixin(reverseProxyCertificate)
fn withServiceFabricZonalUpgradeMode(serviceFabricZonalUpgradeMode)
fn withTags(tags)
fn withTagsMixin(tags)
fn withUpgradeMode(upgradeMode)
fn withUpgradePolicy(upgradePolicy)
fn withUpgradePolicyMixin(upgradePolicy)
fn withVmImage(vmImage)
fn withVmssZonalUpgradeMode(vmssZonalUpgradeMode)
obj spec.forProvider.azureActiveDirectory
obj spec.forProvider.certificate
obj spec.forProvider.certificateCommonNames
obj spec.forProvider.clientCertificateCommonName
obj spec.forProvider.clientCertificateThumbprint
obj spec.forProvider.diagnosticsConfig
obj spec.forProvider.fabricSettings
obj spec.forProvider.nodeType
fn withApplicationPorts(applicationPorts)
fn withApplicationPortsMixin(applicationPorts)
fn withCapacities(capacities)
fn withCapacitiesMixin(capacities)
fn withClientEndpointPort(clientEndpointPort)
fn withDurabilityLevel(durabilityLevel)
fn withEphemeralPorts(ephemeralPorts)
fn withEphemeralPortsMixin(ephemeralPorts)
fn withHttpEndpointPort(httpEndpointPort)
fn withInstanceCount(instanceCount)
fn withIsPrimary(isPrimary)
fn withIsStateless(isStateless)
fn withMultipleAvailabilityZones(multipleAvailabilityZones)
fn withName(name)
fn withPlacementProperties(placementProperties)
fn withPlacementPropertiesMixin(placementProperties)
fn withReverseProxyEndpointPort(reverseProxyEndpointPort)
obj spec.forProvider.nodeType.applicationPorts
obj spec.forProvider.nodeType.ephemeralPorts
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.reverseProxyCertificate
obj spec.forProvider.reverseProxyCertificateCommonNames
obj spec.forProvider.upgradePolicy
fn withDeltaHealthPolicy(deltaHealthPolicy)
fn withDeltaHealthPolicyMixin(deltaHealthPolicy)
fn withForceRestartEnabled(forceRestartEnabled)
fn withHealthCheckRetryTimeout(healthCheckRetryTimeout)
fn withHealthCheckStableDuration(healthCheckStableDuration)
fn withHealthCheckWaitDuration(healthCheckWaitDuration)
fn withHealthPolicy(healthPolicy)
fn withHealthPolicyMixin(healthPolicy)
fn withUpgradeDomainTimeout(upgradeDomainTimeout)
fn withUpgradeReplicaSetCheckTimeout(upgradeReplicaSetCheckTimeout)
fn withUpgradeTimeout(upgradeTimeout)
obj spec.forProvider.upgradePolicy.deltaHealthPolicy
obj spec.forProvider.upgradePolicy.healthPolicy
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of Cluster
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
"ClusterSpec defines the desired state of Cluster"
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.withAddOnFeatures
withAddOnFeatures(addOnFeatures)
"A List of one or more features which should be enabled, such as DnsService."
fn spec.forProvider.withAddOnFeaturesMixin
withAddOnFeaturesMixin(addOnFeatures)
"A List of one or more features which should be enabled, such as DnsService."
Note: This function appends passed data to existing values
fn spec.forProvider.withAzureActiveDirectory
withAzureActiveDirectory(azureActiveDirectory)
"An azure_active_directory block as defined below."
fn spec.forProvider.withAzureActiveDirectoryMixin
withAzureActiveDirectoryMixin(azureActiveDirectory)
"An azure_active_directory block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withCertificate
withCertificate(certificate)
"A certificate block as defined below. Conflicts with certificate_common_names."
fn spec.forProvider.withCertificateCommonNames
withCertificateCommonNames(certificateCommonNames)
"A certificate_common_names block as defined below. Conflicts with certificate."
fn spec.forProvider.withCertificateCommonNamesMixin
withCertificateCommonNamesMixin(certificateCommonNames)
"A certificate_common_names block as defined below. Conflicts with certificate."
Note: This function appends passed data to existing values
fn spec.forProvider.withCertificateMixin
withCertificateMixin(certificate)
"A certificate block as defined below. Conflicts with certificate_common_names."
Note: This function appends passed data to existing values
fn spec.forProvider.withClientCertificateCommonName
withClientCertificateCommonName(clientCertificateCommonName)
"A client_certificate_common_name block as defined below."
fn spec.forProvider.withClientCertificateCommonNameMixin
withClientCertificateCommonNameMixin(clientCertificateCommonName)
"A client_certificate_common_name block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withClientCertificateThumbprint
withClientCertificateThumbprint(clientCertificateThumbprint)
"One or more client_certificate_thumbprint blocks as defined below."
fn spec.forProvider.withClientCertificateThumbprintMixin
withClientCertificateThumbprintMixin(clientCertificateThumbprint)
"One or more client_certificate_thumbprint blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withClusterCodeVersion
withClusterCodeVersion(clusterCodeVersion)
"Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster."
fn spec.forProvider.withDiagnosticsConfig
withDiagnosticsConfig(diagnosticsConfig)
"A diagnostics_config block as defined below."
fn spec.forProvider.withDiagnosticsConfigMixin
withDiagnosticsConfigMixin(diagnosticsConfig)
"A diagnostics_config block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withFabricSettings
withFabricSettings(fabricSettings)
"One or more fabric_settings blocks as defined below."
fn spec.forProvider.withFabricSettingsMixin
withFabricSettingsMixin(fabricSettings)
"One or more fabric_settings blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withLocation
withLocation(location)
"Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withManagementEndpoint
withManagementEndpoint(managementEndpoint)
"Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created."
fn spec.forProvider.withNodeType
withNodeType(nodeType)
"One or more node_type blocks as defined below."
fn spec.forProvider.withNodeTypeMixin
withNodeTypeMixin(nodeType)
"One or more node_type blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withReliabilityLevel
withReliabilityLevel(reliabilityLevel)
"Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum."
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created."
fn spec.forProvider.withReverseProxyCertificate
withReverseProxyCertificate(reverseProxyCertificate)
"A reverse_proxy_certificate block as defined below. Conflicts with reverse_proxy_certificate_common_names."
fn spec.forProvider.withReverseProxyCertificateCommonNames
withReverseProxyCertificateCommonNames(reverseProxyCertificateCommonNames)
"A reverse_proxy_certificate_common_names block as defined below. Conflicts with reverse_proxy_certificate."
fn spec.forProvider.withReverseProxyCertificateCommonNamesMixin
withReverseProxyCertificateCommonNamesMixin(reverseProxyCertificateCommonNames)
"A reverse_proxy_certificate_common_names block as defined below. Conflicts with reverse_proxy_certificate."
Note: This function appends passed data to existing values
fn spec.forProvider.withReverseProxyCertificateMixin
withReverseProxyCertificateMixin(reverseProxyCertificate)
"A reverse_proxy_certificate block as defined below. Conflicts with reverse_proxy_certificate_common_names."
Note: This function appends passed data to existing values
fn spec.forProvider.withServiceFabricZonalUpgradeMode
withServiceFabricZonalUpgradeMode(serviceFabricZonalUpgradeMode)
"Specifies the logical grouping of VMs in upgrade domains. Possible values are Hierarchical or Parallel."
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.withUpgradeMode
withUpgradeMode(upgradeMode)
"Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual."
fn spec.forProvider.withUpgradePolicy
withUpgradePolicy(upgradePolicy)
"A upgrade_policy block as defined below."
fn spec.forProvider.withUpgradePolicyMixin
withUpgradePolicyMixin(upgradePolicy)
"A upgrade_policy block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withVmImage
withVmImage(vmImage)
"Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created."
fn spec.forProvider.withVmssZonalUpgradeMode
withVmssZonalUpgradeMode(vmssZonalUpgradeMode)
"Specifies the upgrade mode for the virtual machine scale set updates that happen in all availability zones at once. Possible values are Hierarchical or Parallel."
obj spec.forProvider.azureActiveDirectory
"An azure_active_directory block as defined below."
fn spec.forProvider.azureActiveDirectory.withClientApplicationId
withClientApplicationId(clientApplicationId)
"The Azure Active Directory Client ID which should be used for the Client Application."
fn spec.forProvider.azureActiveDirectory.withClusterApplicationId
withClusterApplicationId(clusterApplicationId)
"The Azure Active Directory Cluster Application ID."
fn spec.forProvider.azureActiveDirectory.withTenantId
withTenantId(tenantId)
"The Azure Active Directory Tenant ID."
obj spec.forProvider.certificate
"A certificate block as defined below. Conflicts with certificate_common_names."
fn spec.forProvider.certificate.withThumbprint
withThumbprint(thumbprint)
"The Thumbprint of the Certificate."
fn spec.forProvider.certificate.withThumbprintSecondary
withThumbprintSecondary(thumbprintSecondary)
"The Secondary Thumbprint of the Certificate."
fn spec.forProvider.certificate.withX509StoreName
withX509StoreName(x509StoreName)
"The X509 Store where the Certificate Exists, such as My."
obj spec.forProvider.certificateCommonNames
"A certificate_common_names block as defined below. Conflicts with certificate."
fn spec.forProvider.certificateCommonNames.withCommonNames
withCommonNames(commonNames)
"A common_names block as defined below."
fn spec.forProvider.certificateCommonNames.withCommonNamesMixin
withCommonNamesMixin(commonNames)
"A common_names block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.certificateCommonNames.withX509StoreName
withX509StoreName(x509StoreName)
"The X509 Store where the Certificate Exists, such as My."
obj spec.forProvider.certificateCommonNames.commonNames
"A common_names block as defined below."
fn spec.forProvider.certificateCommonNames.commonNames.withCertificateCommonName
withCertificateCommonName(certificateCommonName)
"The common or subject name of the certificate."
fn spec.forProvider.certificateCommonNames.commonNames.withCertificateIssuerThumbprint
withCertificateIssuerThumbprint(certificateIssuerThumbprint)
"The Issuer Thumbprint of the Certificate."
obj spec.forProvider.clientCertificateCommonName
"A client_certificate_common_name block as defined below."
fn spec.forProvider.clientCertificateCommonName.withCommonName
withCommonName(commonName)
"The common or subject name of the certificate."
fn spec.forProvider.clientCertificateCommonName.withIsAdmin
withIsAdmin(isAdmin)
"Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster."
fn spec.forProvider.clientCertificateCommonName.withIssuerThumbprint
withIssuerThumbprint(issuerThumbprint)
"The Issuer Thumbprint of the Certificate."
obj spec.forProvider.clientCertificateThumbprint
"One or more client_certificate_thumbprint blocks as defined below."
fn spec.forProvider.clientCertificateThumbprint.withIsAdmin
withIsAdmin(isAdmin)
"Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster."
fn spec.forProvider.clientCertificateThumbprint.withThumbprint
withThumbprint(thumbprint)
"The Thumbprint associated with the Client Certificate."
obj spec.forProvider.diagnosticsConfig
"A diagnostics_config block as defined below."
fn spec.forProvider.diagnosticsConfig.withBlobEndpoint
withBlobEndpoint(blobEndpoint)
"The Blob Endpoint of the Storage Account."
fn spec.forProvider.diagnosticsConfig.withProtectedAccountKeyName
withProtectedAccountKeyName(protectedAccountKeyName)
"The protected diagnostics storage key name, such as StorageAccountKey1."
fn spec.forProvider.diagnosticsConfig.withQueueEndpoint
withQueueEndpoint(queueEndpoint)
"The Queue Endpoint of the Storage Account."
fn spec.forProvider.diagnosticsConfig.withStorageAccountName
withStorageAccountName(storageAccountName)
"The name of the Storage Account where the Diagnostics should be sent to."
fn spec.forProvider.diagnosticsConfig.withTableEndpoint
withTableEndpoint(tableEndpoint)
"The Table Endpoint of the Storage Account."
obj spec.forProvider.fabricSettings
"One or more fabric_settings blocks as defined below."
fn spec.forProvider.fabricSettings.withName
withName(name)
"The name of the Fabric Setting, such as Security or Federation."
fn spec.forProvider.fabricSettings.withParameters
withParameters(parameters)
"A map containing settings for the specified Fabric Setting."
fn spec.forProvider.fabricSettings.withParametersMixin
withParametersMixin(parameters)
"A map containing settings for the specified Fabric Setting."
Note: This function appends passed data to existing values
obj spec.forProvider.nodeType
"One or more node_type blocks as defined below."
fn spec.forProvider.nodeType.withApplicationPorts
withApplicationPorts(applicationPorts)
"A application_ports block as defined below."
fn spec.forProvider.nodeType.withApplicationPortsMixin
withApplicationPortsMixin(applicationPorts)
"A application_ports block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.nodeType.withCapacities
withCapacities(capacities)
"The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has."
fn spec.forProvider.nodeType.withCapacitiesMixin
withCapacitiesMixin(capacities)
"The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has."
Note: This function appends passed data to existing values
fn spec.forProvider.nodeType.withClientEndpointPort
withClientEndpointPort(clientEndpointPort)
"The Port used for the Client Endpoint for this Node Type."
fn spec.forProvider.nodeType.withDurabilityLevel
withDurabilityLevel(durabilityLevel)
"The Durability Level for this Node Type. Possible values include Bronze, Gold and Silver. Defaults to Bronze."
fn spec.forProvider.nodeType.withEphemeralPorts
withEphemeralPorts(ephemeralPorts)
"A ephemeral_ports block as defined below."
fn spec.forProvider.nodeType.withEphemeralPortsMixin
withEphemeralPortsMixin(ephemeralPorts)
"A ephemeral_ports block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.nodeType.withHttpEndpointPort
withHttpEndpointPort(httpEndpointPort)
"The Port used for the HTTP Endpoint for this Node Type."
fn spec.forProvider.nodeType.withInstanceCount
withInstanceCount(instanceCount)
"The number of nodes for this Node Type."
fn spec.forProvider.nodeType.withIsPrimary
withIsPrimary(isPrimary)
"Is this the Primary Node Type?"
fn spec.forProvider.nodeType.withIsStateless
withIsStateless(isStateless)
"Should this node type run only stateless services?"
fn spec.forProvider.nodeType.withMultipleAvailabilityZones
withMultipleAvailabilityZones(multipleAvailabilityZones)
"Does this node type span availability zones?"
fn spec.forProvider.nodeType.withName
withName(name)
"The name of the Node Type."
fn spec.forProvider.nodeType.withPlacementProperties
withPlacementProperties(placementProperties)
"The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run."
fn spec.forProvider.nodeType.withPlacementPropertiesMixin
withPlacementPropertiesMixin(placementProperties)
"The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run."
Note: This function appends passed data to existing values
fn spec.forProvider.nodeType.withReverseProxyEndpointPort
withReverseProxyEndpointPort(reverseProxyEndpointPort)
"The Port used for the Reverse Proxy Endpoint for this Node Type. Changing this will upgrade the cluster."
obj spec.forProvider.nodeType.applicationPorts
"A application_ports block as defined below."
fn spec.forProvider.nodeType.applicationPorts.withEndPort
withEndPort(endPort)
"The end of the Ephemeral Port Range on this Node Type."
fn spec.forProvider.nodeType.applicationPorts.withStartPort
withStartPort(startPort)
"The start of the Ephemeral Port Range on this Node Type."
obj spec.forProvider.nodeType.ephemeralPorts
"A ephemeral_ports block as defined below."
fn spec.forProvider.nodeType.ephemeralPorts.withEndPort
withEndPort(endPort)
"The end of the Ephemeral Port Range on this Node Type."
fn spec.forProvider.nodeType.ephemeralPorts.withStartPort
withStartPort(startPort)
"The start of the Ephemeral Port Range on this Node Type."
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.forProvider.reverseProxyCertificate
"A reverse_proxy_certificate block as defined below. Conflicts with reverse_proxy_certificate_common_names."
fn spec.forProvider.reverseProxyCertificate.withThumbprint
withThumbprint(thumbprint)
"The Thumbprint of the Certificate."
fn spec.forProvider.reverseProxyCertificate.withThumbprintSecondary
withThumbprintSecondary(thumbprintSecondary)
"The Secondary Thumbprint of the Certificate."
fn spec.forProvider.reverseProxyCertificate.withX509StoreName
withX509StoreName(x509StoreName)
"The X509 Store where the Certificate Exists, such as My."
obj spec.forProvider.reverseProxyCertificateCommonNames
"A reverse_proxy_certificate_common_names block as defined below. Conflicts with reverse_proxy_certificate."
fn spec.forProvider.reverseProxyCertificateCommonNames.withCommonNames
withCommonNames(commonNames)
"A common_names block as defined below."
fn spec.forProvider.reverseProxyCertificateCommonNames.withCommonNamesMixin
withCommonNamesMixin(commonNames)
"A common_names block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.reverseProxyCertificateCommonNames.withX509StoreName
withX509StoreName(x509StoreName)
"The X509 Store where the Certificate Exists, such as My."
obj spec.forProvider.reverseProxyCertificateCommonNames.commonNames
"A common_names block as defined below."
fn spec.forProvider.reverseProxyCertificateCommonNames.commonNames.withCertificateCommonName
withCertificateCommonName(certificateCommonName)
"The common or subject name of the certificate."
fn spec.forProvider.reverseProxyCertificateCommonNames.commonNames.withCertificateIssuerThumbprint
withCertificateIssuerThumbprint(certificateIssuerThumbprint)
"The Issuer Thumbprint of the Certificate."
obj spec.forProvider.upgradePolicy
"A upgrade_policy block as defined below."
fn spec.forProvider.upgradePolicy.withDeltaHealthPolicy
withDeltaHealthPolicy(deltaHealthPolicy)
"A delta_health_policy block as defined below"
fn spec.forProvider.upgradePolicy.withDeltaHealthPolicyMixin
withDeltaHealthPolicyMixin(deltaHealthPolicy)
"A delta_health_policy block as defined below"
Note: This function appends passed data to existing values
fn spec.forProvider.upgradePolicy.withForceRestartEnabled
withForceRestartEnabled(forceRestartEnabled)
"Indicates whether to restart the Service Fabric node even if only dynamic configurations have changed."
fn spec.forProvider.upgradePolicy.withHealthCheckRetryTimeout
withHealthCheckRetryTimeout(healthCheckRetryTimeout)
"Specifies the duration, in \"hh:mm:ss\" string format, after which Service Fabric retries the health check if the previous health check fails. Defaults to 00:45:00."
fn spec.forProvider.upgradePolicy.withHealthCheckStableDuration
withHealthCheckStableDuration(healthCheckStableDuration)
"Specifies the duration, in \"hh:mm:ss\" string format, that Service Fabric waits in order to verify that the cluster is stable before it continues to the next upgrade domain or completes the upgrade. This wait duration prevents undetected changes of health right after the health check is performed. Defaults to 00:01:00."
fn spec.forProvider.upgradePolicy.withHealthCheckWaitDuration
withHealthCheckWaitDuration(healthCheckWaitDuration)
"Specifies the duration, in \"hh:mm:ss\" string format, that Service Fabric waits before it performs the initial health check after it finishes the upgrade on the upgrade domain. Defaults to 00:00:30."
fn spec.forProvider.upgradePolicy.withHealthPolicy
withHealthPolicy(healthPolicy)
"A health_policy block as defined below"
fn spec.forProvider.upgradePolicy.withHealthPolicyMixin
withHealthPolicyMixin(healthPolicy)
"A health_policy block as defined below"
Note: This function appends passed data to existing values
fn spec.forProvider.upgradePolicy.withUpgradeDomainTimeout
withUpgradeDomainTimeout(upgradeDomainTimeout)
"Specifies the duration, in \"hh:mm:ss\" string format, that Service Fabric takes to upgrade a single upgrade domain. After this period, the upgrade fails. Defaults to 02:00:00."
fn spec.forProvider.upgradePolicy.withUpgradeReplicaSetCheckTimeout
withUpgradeReplicaSetCheckTimeout(upgradeReplicaSetCheckTimeout)
"Specifies the duration, in \"hh:mm:ss\" string format, that Service Fabric waits for a replica set to reconfigure into a safe state, if it is not already in a safe state, before Service Fabric proceeds with the upgrade. Defaults to 10675199.02:48:05.4775807."
fn spec.forProvider.upgradePolicy.withUpgradeTimeout
withUpgradeTimeout(upgradeTimeout)
"Specifies the duration, in \"hh:mm:ss\" string format, that Service Fabric takes for the entire upgrade. After this period, the upgrade fails. Defaults to 12:00:00."
obj spec.forProvider.upgradePolicy.deltaHealthPolicy
"A delta_health_policy block as defined below"
fn spec.forProvider.upgradePolicy.deltaHealthPolicy.withMaxDeltaUnhealthyApplicationsPercent
withMaxDeltaUnhealthyApplicationsPercent(maxDeltaUnhealthyApplicationsPercent)
"Specifies the maximum tolerated percentage of delta unhealthy applications that can have aggregated health states of error. If the current unhealthy applications do not respect the percentage relative to the state at the beginning of the upgrade, the cluster is unhealthy. Defaults to 0."
fn spec.forProvider.upgradePolicy.deltaHealthPolicy.withMaxDeltaUnhealthyNodesPercent
withMaxDeltaUnhealthyNodesPercent(maxDeltaUnhealthyNodesPercent)
"Specifies the maximum tolerated percentage of delta unhealthy nodes that can have aggregated health states of error. If the current unhealthy nodes do not respect the percentage relative to the state at the beginning of the upgrade, the cluster is unhealthy. Defaults to 0."
fn spec.forProvider.upgradePolicy.deltaHealthPolicy.withMaxUpgradeDomainDeltaUnhealthyNodesPercent
withMaxUpgradeDomainDeltaUnhealthyNodesPercent(maxUpgradeDomainDeltaUnhealthyNodesPercent)
"Specifies the maximum tolerated percentage of upgrade domain delta unhealthy nodes that can have aggregated health state of error. If there is any upgrade domain where the current unhealthy nodes do not respect the percentage relative to the state at the beginning of the upgrade, the cluster is unhealthy. Defaults to 0."
obj spec.forProvider.upgradePolicy.healthPolicy
"A health_policy block as defined below"
fn spec.forProvider.upgradePolicy.healthPolicy.withMaxUnhealthyApplicationsPercent
withMaxUnhealthyApplicationsPercent(maxUnhealthyApplicationsPercent)
"Specifies the maximum tolerated percentage of applications that can have aggregated health state of error. If the upgrade exceeds this percentage, the cluster is unhealthy. Defaults to 0."
fn spec.forProvider.upgradePolicy.healthPolicy.withMaxUnhealthyNodesPercent
withMaxUnhealthyNodesPercent(maxUnhealthyNodesPercent)
"Specifies the maximum tolerated percentage of nodes that can have aggregated health states of error. If an upgrade exceeds this percentage, the cluster is unhealthy. Defaults to 0."
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."