media.v1beta1.contentKeyPolicy

"ContentKeyPolicy is the Schema for the ContentKeyPolicys API. Manages a Content Key Policy."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of ContentKeyPolicy

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

"ContentKeyPolicySpec defines the desired state of ContentKeyPolicy"

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

withDescription(description)

"A description for the Policy."

fn spec.forProvider.withMediaServicesAccountName

withMediaServicesAccountName(mediaServicesAccountName)

"The Media Services account name. Changing this forces a new Content Key Policy to be created."

fn spec.forProvider.withPolicyOption

withPolicyOption(policyOption)

"One or more policy_option blocks as defined below."

fn spec.forProvider.withPolicyOptionMixin

withPolicyOptionMixin(policyOption)

"One or more policy_option blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the Resource Group where the Content Key Policy should exist. Changing this forces a new Content Key Policy to be created."

obj spec.forProvider.mediaServicesAccountNameRef

"Reference to a ServicesAccount in media to populate mediaServicesAccountName."

fn spec.forProvider.mediaServicesAccountNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.mediaServicesAccountNameRef.policy

"Policies for referencing."

fn spec.forProvider.mediaServicesAccountNameRef.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.mediaServicesAccountNameRef.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.mediaServicesAccountNameSelector

"Selector for a ServicesAccount in media to populate mediaServicesAccountName."

fn spec.forProvider.mediaServicesAccountNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.mediaServicesAccountNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.mediaServicesAccountNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.mediaServicesAccountNameSelector.policy

"Policies for selection."

fn spec.forProvider.mediaServicesAccountNameSelector.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.mediaServicesAccountNameSelector.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.policyOption

"One or more policy_option blocks as defined below."

fn spec.forProvider.policyOption.withClearKeyConfigurationEnabled

withClearKeyConfigurationEnabled(clearKeyConfigurationEnabled)

"Enable a configuration for non-DRM keys."

fn spec.forProvider.policyOption.withFairplayConfiguration

withFairplayConfiguration(fairplayConfiguration)

"A fairplay_configuration block as defined above. Check license requirements here https://docs.microsoft.com/azure/media-services/latest/fairplay-license-overview."

fn spec.forProvider.policyOption.withFairplayConfigurationMixin

withFairplayConfigurationMixin(fairplayConfiguration)

"A fairplay_configuration block as defined above. Check license requirements here https://docs.microsoft.com/azure/media-services/latest/fairplay-license-overview."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.withName

withName(name)

"The name which should be used for this Policy Option."

fn spec.forProvider.policyOption.withOpenRestrictionEnabled

withOpenRestrictionEnabled(openRestrictionEnabled)

"Enable an open restriction. License or key will be delivered on every request."

fn spec.forProvider.policyOption.withPlayreadyConfigurationLicense

withPlayreadyConfigurationLicense(playreadyConfigurationLicense)

"One or more playready_configuration_license blocks as defined above."

fn spec.forProvider.policyOption.withPlayreadyConfigurationLicenseMixin

withPlayreadyConfigurationLicenseMixin(playreadyConfigurationLicense)

"One or more playready_configuration_license blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.withPlayreadyResponseCustomData

withPlayreadyResponseCustomData(playreadyResponseCustomData)

"The custom response data of the PlayReady configuration. This only applies when playready_configuration_license is specified."

fn spec.forProvider.policyOption.withTokenRestriction

withTokenRestriction(tokenRestriction)

"A token_restriction block as defined below."

fn spec.forProvider.policyOption.withTokenRestrictionMixin

withTokenRestrictionMixin(tokenRestriction)

"A token_restriction block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.withWidevineConfigurationTemplate

withWidevineConfigurationTemplate(widevineConfigurationTemplate)

"The Widevine template."

obj spec.forProvider.policyOption.fairplayConfiguration

"A fairplay_configuration block as defined above. Check license requirements here https://docs.microsoft.com/azure/media-services/latest/fairplay-license-overview."

fn spec.forProvider.policyOption.fairplayConfiguration.withOfflineRentalConfiguration

withOfflineRentalConfiguration(offlineRentalConfiguration)

"A offline_rental_configuration block as defined below."

fn spec.forProvider.policyOption.fairplayConfiguration.withOfflineRentalConfigurationMixin

withOfflineRentalConfigurationMixin(offlineRentalConfiguration)

"A offline_rental_configuration block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.fairplayConfiguration.withRentalAndLeaseKeyType

withRentalAndLeaseKeyType(rentalAndLeaseKeyType)

"The rental and lease key type. Supported values are DualExpiry, PersistentLimited, PersistentUnlimited or Undefined."

fn spec.forProvider.policyOption.fairplayConfiguration.withRentalDurationSeconds

withRentalDurationSeconds(rentalDurationSeconds)

"The rental duration. Must be greater than 0."

obj spec.forProvider.policyOption.fairplayConfiguration.askSecretRef

"The key that must be used as FairPlay Application Secret key."

fn spec.forProvider.policyOption.fairplayConfiguration.askSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.fairplayConfiguration.askSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.fairplayConfiguration.askSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.fairplayConfiguration.offlineRentalConfiguration

"A offline_rental_configuration block as defined below."

fn spec.forProvider.policyOption.fairplayConfiguration.offlineRentalConfiguration.withPlaybackDurationSeconds

withPlaybackDurationSeconds(playbackDurationSeconds)

"Playback duration."

fn spec.forProvider.policyOption.fairplayConfiguration.offlineRentalConfiguration.withStorageDurationSeconds

withStorageDurationSeconds(storageDurationSeconds)

"Storage duration."

obj spec.forProvider.policyOption.fairplayConfiguration.pfxPasswordSecretRef

"The password encrypting FairPlay certificate in PKCS 12 (pfx) format."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.fairplayConfiguration.pfxSecretRef

"The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key)."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.fairplayConfiguration.pfxSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.playreadyConfigurationLicense

"One or more playready_configuration_license blocks as defined above."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withAllowTestDevices

withAllowTestDevices(allowTestDevices)

"A flag indicating whether test devices can use the license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withBeginDate

withBeginDate(beginDate)

"The begin date of license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withContentKeyLocationFromHeaderEnabled

withContentKeyLocationFromHeaderEnabled(contentKeyLocationFromHeaderEnabled)

"Specifies that the content key ID is in the PlayReady header."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withContentKeyLocationFromKeyId

withContentKeyLocationFromKeyId(contentKeyLocationFromKeyId)

"The content key ID. Specifies that the content key ID is specified in the PlayReady configuration."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withContentType

withContentType(contentType)

"The PlayReady content type. Supported values are UltraVioletDownload, UltraVioletStreaming or Unspecified."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withExpirationDate

withExpirationDate(expirationDate)

"The expiration date of license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withLicenseType

withLicenseType(licenseType)

"The license type. Supported values are NonPersistent or Persistent."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withPlayRight

withPlayRight(playRight)

"A play_right block as defined above."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withPlayRightMixin

withPlayRightMixin(playRight)

"A play_right block as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withRelativeBeginDate

withRelativeBeginDate(relativeBeginDate)

"The relative begin date of license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withRelativeExpirationDate

withRelativeExpirationDate(relativeExpirationDate)

"The relative expiration date of license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.withSecurityLevel

withSecurityLevel(securityLevel)

"The security level of the PlayReady license. Possible values are SL150, SL2000 and SL3000. Please see this document for more information about security level. See this document for more information about SL3000 support."

obj spec.forProvider.policyOption.playreadyConfigurationLicense.gracePeriodSecretRef

"The grace period of license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.gracePeriodSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.gracePeriodSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.gracePeriodSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.playreadyConfigurationLicense.playRight

"A play_right block as defined above."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withAgcAndColorStripeRestriction

withAgcAndColorStripeRestriction(agcAndColorStripeRestriction)

"Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withAllowPassingVideoContentToUnknownOutput

withAllowPassingVideoContentToUnknownOutput(allowPassingVideoContentToUnknownOutput)

"Configures Unknown output handling settings of the license. Supported values are Allowed, AllowedWithVideoConstriction or NotAllowed."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withAnalogVideoOpl

withAnalogVideoOpl(analogVideoOpl)

"Specifies the output protection level for compressed digital audio. Supported values are 100, 150 or 200."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withCompressedDigitalAudioOpl

withCompressedDigitalAudioOpl(compressedDigitalAudioOpl)

"Specifies the output protection level for compressed digital audio.Supported values are 100, 150, 200, 250 or 300."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withCompressedDigitalVideoOpl

withCompressedDigitalVideoOpl(compressedDigitalVideoOpl)

"Specifies the output protection level for compressed digital video. Supported values are 400 or 500."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withDigitalVideoOnlyContentRestriction

withDigitalVideoOnlyContentRestriction(digitalVideoOnlyContentRestriction)

"Enables the Image Constraint For Analog Component Video Restriction in the license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withExplicitAnalogTelevisionOutputRestriction

withExplicitAnalogTelevisionOutputRestriction(explicitAnalogTelevisionOutputRestriction)

"An explicit_analog_television_output_restriction block as defined above."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withExplicitAnalogTelevisionOutputRestrictionMixin

withExplicitAnalogTelevisionOutputRestrictionMixin(explicitAnalogTelevisionOutputRestriction)

"An explicit_analog_television_output_restriction block as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withFirstPlayExpiration

withFirstPlayExpiration(firstPlayExpiration)

"The amount of time that the license is valid after the license is first used to play content."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withImageConstraintForAnalogComponentVideoRestriction

withImageConstraintForAnalogComponentVideoRestriction(imageConstraintForAnalogComponentVideoRestriction)

"Enables the Image Constraint For Analog Component Video Restriction in the license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withImageConstraintForAnalogComputerMonitorRestriction

withImageConstraintForAnalogComputerMonitorRestriction(imageConstraintForAnalogComputerMonitorRestriction)

"Enables the Image Constraint For Analog Component Video Restriction in the license."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withScmsRestriction

withScmsRestriction(scmsRestriction)

"Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withUncompressedDigitalAudioOpl

withUncompressedDigitalAudioOpl(uncompressedDigitalAudioOpl)

"Specifies the output protection level for uncompressed digital audio. Supported values are 100, 150, 200, 250 or 300."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.withUncompressedDigitalVideoOpl

withUncompressedDigitalVideoOpl(uncompressedDigitalVideoOpl)

"Specifies the output protection level for uncompressed digital video. Supported values are 100, 250, 270 or 300."

obj spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.explicitAnalogTelevisionOutputRestriction

"An explicit_analog_television_output_restriction block as defined above."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.explicitAnalogTelevisionOutputRestriction.withBestEffortEnforced

withBestEffortEnforced(bestEffortEnforced)

"Indicates whether this restriction is enforced on a best effort basis. Possible values are true or false. Defaults to false."

fn spec.forProvider.policyOption.playreadyConfigurationLicense.playRight.explicitAnalogTelevisionOutputRestriction.withControlBits

withControlBits(controlBits)

"The restriction control bits. Possible value is integer between 0 and 3 inclusive."

obj spec.forProvider.policyOption.tokenRestriction

"A token_restriction block as defined below."

fn spec.forProvider.policyOption.tokenRestriction.withAlternateKey

withAlternateKey(alternateKey)

"One or more alternate_key block as defined above."

fn spec.forProvider.policyOption.tokenRestriction.withAlternateKeyMixin

withAlternateKeyMixin(alternateKey)

"One or more alternate_key block as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.tokenRestriction.withAudience

withAudience(audience)

"The audience for the token."

fn spec.forProvider.policyOption.tokenRestriction.withIssuer

withIssuer(issuer)

"The token issuer."

fn spec.forProvider.policyOption.tokenRestriction.withOpenIdConnectDiscoveryDocument

withOpenIdConnectDiscoveryDocument(openIdConnectDiscoveryDocument)

"The OpenID connect discovery document."

fn spec.forProvider.policyOption.tokenRestriction.withRequiredClaim

withRequiredClaim(requiredClaim)

"One or more required_claim blocks as defined above."

fn spec.forProvider.policyOption.tokenRestriction.withRequiredClaimMixin

withRequiredClaimMixin(requiredClaim)

"One or more required_claim blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.policyOption.tokenRestriction.withTokenType

withTokenType(tokenType)

"The type of token. Supported values are Jwt or Swt."

obj spec.forProvider.policyOption.tokenRestriction.alternateKey

"One or more alternate_key block as defined above."

obj spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyExponentSecretRef

"The RSA parameter exponent."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyExponentSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyExponentSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyExponentSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyModulusSecretRef

"The RSA parameter modulus."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyModulusSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyModulusSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.rsaTokenKeyModulusSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.alternateKey.symmetricTokenKeySecretRef

"The key value of the key. Specifies a symmetric key for token validation."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.symmetricTokenKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.symmetricTokenKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.symmetricTokenKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.alternateKey.x509TokenKeyRawSecretRef

"The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET). Specifies a certificate for token validation."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.x509TokenKeyRawSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.x509TokenKeyRawSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.alternateKey.x509TokenKeyRawSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyExponentSecretRef

"The RSA parameter exponent."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyExponentSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyExponentSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyExponentSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyModulusSecretRef

"The RSA parameter modulus."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyModulusSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyModulusSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.primaryRsaTokenKeyModulusSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.primarySymmetricTokenKeySecretRef

"The key value of the key. Specifies a symmetric key for token validation."

fn spec.forProvider.policyOption.tokenRestriction.primarySymmetricTokenKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.primarySymmetricTokenKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.primarySymmetricTokenKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.primaryX509TokenKeyRawSecretRef

"The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET). Specifies a certificate for token validation."

fn spec.forProvider.policyOption.tokenRestriction.primaryX509TokenKeyRawSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.policyOption.tokenRestriction.primaryX509TokenKeyRawSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.policyOption.tokenRestriction.primaryX509TokenKeyRawSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.policyOption.tokenRestriction.requiredClaim

"One or more required_claim blocks as defined above."

fn spec.forProvider.policyOption.tokenRestriction.requiredClaim.withType

withType(type)

"Token claim type."

fn spec.forProvider.policyOption.tokenRestriction.requiredClaim.withValue

withValue(value)

"Token claim value."

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