DirectoryEntitlement
Kind
account.btp.sap.crossplane.io
Group
v1alpha1
Version

apiVersion: account.btp.sap.crossplane.io/v1alpha1
kind: DirectoryEntitlement

DirectoryEntitlement is the Schema for the DirectoryEntitlements API. Assigns the entitlement plan of a service, multitenant application, or environment, to a directory. Note that some environments, such as Cloud Foundry, are available by default to all global accounts and their directorys, and therefore are not made available as entitlements. Tip: You must be assigned to the admin role of the global account or the directory. Further documentation: https://help.sap.com/docs/btp/sap-business-technology-platform/entitlements-and-quotas

spec object

DirectoryEntitlementSpec defines the desired state of DirectoryEntitlement


deletionPolicy string

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

forProvider object required

No Description Provided.


amount number

(Number) The quota assigned to the directory. The quota assigned to the directory.

autoAssign boolean

(Boolean) Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory. Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory.

autoDistributeAmount number

(Number) The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota. The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota.

directoryId string

(String) The ID of the directory. The ID of the directory.

directoryRef object

Reference to a Directory in account to populate directoryId.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

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.

resolve string

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.

directorySelector object

Selector for a Directory in account to populate directoryId.


matchControllerRef boolean

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

matchLabels object

MatchLabels ensures an object with matching labels is selected.

policy object

Policies for selection.


resolution string

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.

resolve string

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.

distribute boolean

(Boolean) Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set. Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set.

planName string

(String) The name of the entitled service plan. The name of the entitled service plan.

serviceName string

(String) The name of the entitled service. The name of the entitled service.

initProvider object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.


amount number

(Number) The quota assigned to the directory. The quota assigned to the directory.

autoAssign boolean

(Boolean) Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory. Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory.

autoDistributeAmount number

(Number) The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota. The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota.

directoryId string

(String) The ID of the directory. The ID of the directory.

directoryRef object

Reference to a Directory in account to populate directoryId.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

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.

resolve string

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.

directorySelector object

Selector for a Directory in account to populate directoryId.


matchControllerRef boolean

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

matchLabels object

MatchLabels ensures an object with matching labels is selected.

policy object

Policies for selection.


resolution string

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.

resolve string

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.

distribute boolean

(Boolean) Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set. Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set.

planName string

(String) The name of the entitled service plan. The name of the entitled service plan.

serviceName string

(String) The name of the entitled service. The name of the entitled service.

managementPolicies []string

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

providerConfigRef object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

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.

resolve string

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.

publishConnectionDetailsTo object

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.


configRef object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

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.

resolve string

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.

metadata object

Metadata is the metadata for connection secret.


annotations object

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.
labels object

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.
type string

Type is the SecretType for the connection secret.

  • Only valid for Kubernetes Secret Stores.
name string required

Name is the name of the connection secret.

writeConnectionSecretToRef object

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.


name string required

Name of the secret.

namespace string required

Namespace of the secret.

status object

DirectoryEntitlementStatus defines the observed state of DirectoryEntitlement.


atProvider object

No Description Provided.


amount number

(Number) The quota assigned to the directory. The quota assigned to the directory.

autoAssign boolean

(Boolean) Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory. Determines whether the plans of entitlements that have a numeric quota with the amount specified in auto_distribute_amount are automatically allocated to any new subaccount that is added to the directory in the future. For entitlements without a numeric quota, it shows if the plan are assigned to any new subaccount that is added to the directory in the future (auto_distribute_amount is not needed). If the distribute parameter is set, the same assignment is also made to all subaccounts currently in the directory. Entitlements are subject to available quota in the directory.

autoDistributeAmount number

(Number) The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota. The quota of the specified plan automatically allocated to any new subaccount that is created in the future in the directory. When applying this option, auto_assign and/or distribute must also be set. Applies only to entitlements that have a numeric quota.

category string

(String) The current state of the entitlement. Possible values are: The current state of the entitlement. Possible values are:

value description
PLATFORM A service required for using a specific platform; for example, Application Runtime is required for the Cloud Foundry platform.
SERVICE A commercial or technical service. that has a numeric quota (amount) when entitled or assigned to a resource. When assigning entitlements of this type, use the 'amount' option.
ELASTIC_SERVICE A commercial or technical service that has no numeric quota (amount) when entitled or assigned to a resource. Generally this type of service can be as many times as needed when enabled, but may in some cases be restricted by the service owner.
ELASTIC_LIMITED An elastic service that can be enabled for only one subaccount per global account.
APPLICATION A multitenant application to which consumers can subscribe. As opposed to applications defined as a 'QUOTA_BASED_APPLICATION', these applications do not have a numeric quota and are simply enabled or disabled as entitlements per subaccount.
QUOTA_BASED_APPLICATION A multitenant application to which consumers can subscribe. As opposed to applications defined as 'APPLICATION', these applications have an numeric quota that limits consumer usage of the subscribed application per subaccount.
ENVIRONMENT An environment service; for example, Cloud Foundry.
directoryId string

(String) The ID of the directory. The ID of the directory.

distribute boolean

(Boolean) Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set. Defines the assignment of the plan with the quota specified in auto_distribute_amount to subaccounts currently located in the specified directory. For entitlements without a numeric quota, the plan is assigned to the subaccounts currently located in the directory (auto_distribute_amount is not needed). When applying this option, auto_assign must also be set.

id string

(String) The ID of the entitled service plan.

planId string

(String) The ID of the entitled service plan. The ID of the entitled service plan.

planName string

(String) The name of the entitled service plan. The name of the entitled service plan.

serviceName string

(String) The name of the entitled service. The name of the entitled service.

conditions []object

Conditions of the resource.


lastTransitionTime string required

LastTransitionTime is the last time this condition transitioned from one status to another.

message string

A Message containing details about this condition's last transition from one status to another, if any.

reason string required

A Reason for this condition's last transition from one status to another.

status string required

Status of this condition; is it currently True, False, or Unknown?

type string required

Type of this condition. At most one of each condition type may apply to a resource at any point in time.