Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=orgpolicy.gcp.jet.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type ConditionObservation
- type ConditionParameters
- type Policy
- func (in *Policy) DeepCopy() *Policy
- func (in *Policy) DeepCopyInto(out *Policy)
- func (in *Policy) DeepCopyObject() runtime.Object
- func (mg *Policy) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Policy) GetConnectionDetailsMapping() map[string]string
- func (mg *Policy) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Policy) GetID() string
- func (tr *Policy) GetObservation() (map[string]interface{}, error)
- func (tr *Policy) GetParameters() (map[string]interface{}, error)
- func (mg *Policy) GetProviderConfigReference() *xpv1.Reference
- func (mg *Policy) GetProviderReference() *xpv1.Reference
- func (mg *Policy) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Policy) GetTerraformResourceType() string
- func (tr *Policy) GetTerraformSchemaVersion() int
- func (mg *Policy) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Policy) LateInitialize(attrs []byte) (bool, error)
- func (mg *Policy) SetConditions(c ...xpv1.Condition)
- func (mg *Policy) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (tr *Policy) SetObservation(obs map[string]interface{}) error
- func (tr *Policy) SetParameters(params map[string]interface{}) error
- func (mg *Policy) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Policy) SetProviderReference(r *xpv1.Reference)
- func (mg *Policy) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Policy) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type PolicyList
- type PolicyObservation
- type PolicyParameters
- type PolicySpec
- type PolicyStatus
- type RulesObservation
- type RulesParameters
- type SpecObservation
- type SpecParameters
- type ValuesObservation
- type ValuesParameters
Constants ¶
const ( CRDGroup = "orgpolicy.gcp.jet.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( Policy_Kind = "Policy" Policy_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Policy_Kind}.String() Policy_KindAPIVersion = Policy_Kind + "." + CRDGroupVersion.String() Policy_GroupVersionKind = CRDGroupVersion.WithKind(Policy_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type ConditionObservation ¶
type ConditionObservation struct { }
func (*ConditionObservation) DeepCopy ¶
func (in *ConditionObservation) DeepCopy() *ConditionObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionObservation.
func (*ConditionObservation) DeepCopyInto ¶
func (in *ConditionObservation) DeepCopyInto(out *ConditionObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionParameters ¶
type ConditionParameters struct { // Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. // +kubebuilder:validation:Optional Description *string `json:"description,omitempty" tf:"description,omitempty"` // Textual representation of an expression in Common Expression Language syntax. // +kubebuilder:validation:Optional Expression *string `json:"expression,omitempty" tf:"expression,omitempty"` // Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. // +kubebuilder:validation:Optional Location *string `json:"location,omitempty" tf:"location,omitempty"` // Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. // +kubebuilder:validation:Optional Title *string `json:"title,omitempty" tf:"title,omitempty"` }
func (*ConditionParameters) DeepCopy ¶
func (in *ConditionParameters) DeepCopy() *ConditionParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionParameters.
func (*ConditionParameters) DeepCopyInto ¶
func (in *ConditionParameters) DeepCopyInto(out *ConditionParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Policy ¶
type Policy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PolicySpec `json:"spec"` Status PolicyStatus `json:"status,omitempty"` }
Policy is the Schema for the Policys API +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,gcpjet}
func (*Policy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Policy) GetCondition ¶
func (mg *Policy) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Policy.
func (*Policy) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Policy
func (*Policy) GetDeletionPolicy ¶
func (mg *Policy) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Policy.
func (*Policy) GetObservation ¶
GetObservation of this Policy
func (*Policy) GetParameters ¶
GetParameters of this Policy
func (*Policy) GetProviderConfigReference ¶
GetProviderConfigReference of this Policy.
func (*Policy) GetProviderReference ¶
GetProviderReference of this Policy. Deprecated: Use GetProviderConfigReference.
func (*Policy) GetPublishConnectionDetailsTo ¶
func (mg *Policy) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Policy.
func (*Policy) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Policy
func (*Policy) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Policy) GetWriteConnectionSecretToReference ¶
func (mg *Policy) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Policy.
func (*Policy) LateInitialize ¶
LateInitialize this Policy using its observed tfState. returns True if there are any spec changes for the resource.
func (*Policy) SetConditions ¶
SetConditions of this Policy.
func (*Policy) SetDeletionPolicy ¶
func (mg *Policy) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Policy.
func (*Policy) SetObservation ¶
SetObservation for this Policy
func (*Policy) SetParameters ¶
SetParameters for this Policy
func (*Policy) SetProviderConfigReference ¶
SetProviderConfigReference of this Policy.
func (*Policy) SetProviderReference ¶
SetProviderReference of this Policy. Deprecated: Use SetProviderConfigReference.
func (*Policy) SetPublishConnectionDetailsTo ¶
func (mg *Policy) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Policy.
func (*Policy) SetWriteConnectionSecretToReference ¶
func (mg *Policy) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Policy.
type PolicyList ¶
type PolicyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Policy `json:"items"` }
PolicyList contains a list of Policys
func (*PolicyList) DeepCopy ¶
func (in *PolicyList) DeepCopy() *PolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyList.
func (*PolicyList) DeepCopyInto ¶
func (in *PolicyList) DeepCopyInto(out *PolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolicyList) DeepCopyObject ¶
func (in *PolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolicyList) GetItems ¶
func (l *PolicyList) GetItems() []resource.Managed
GetItems of this PolicyList.
type PolicyObservation ¶
type PolicyObservation struct {
ID *string `json:"id,omitempty" tf:"id,omitempty"`
}
func (*PolicyObservation) DeepCopy ¶
func (in *PolicyObservation) DeepCopy() *PolicyObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyObservation.
func (*PolicyObservation) DeepCopyInto ¶
func (in *PolicyObservation) DeepCopyInto(out *PolicyObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicyParameters ¶
type PolicyParameters struct { // Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. // +kubebuilder:validation:Required Name *string `json:"name" tf:"name,omitempty"` // The parent of the resource. // +kubebuilder:validation:Required Parent *string `json:"parent" tf:"parent,omitempty"` // Basic information about the Organization Policy. // +kubebuilder:validation:Optional Spec []SpecParameters `json:"spec,omitempty" tf:"spec,omitempty"` }
func (*PolicyParameters) DeepCopy ¶
func (in *PolicyParameters) DeepCopy() *PolicyParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyParameters.
func (*PolicyParameters) DeepCopyInto ¶
func (in *PolicyParameters) DeepCopyInto(out *PolicyParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicySpec ¶
type PolicySpec struct { v1.ResourceSpec `json:",inline"` ForProvider PolicyParameters `json:"forProvider"` }
PolicySpec defines the desired state of Policy
func (*PolicySpec) DeepCopy ¶
func (in *PolicySpec) DeepCopy() *PolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicySpec.
func (*PolicySpec) DeepCopyInto ¶
func (in *PolicySpec) DeepCopyInto(out *PolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicyStatus ¶
type PolicyStatus struct { v1.ResourceStatus `json:",inline"` AtProvider PolicyObservation `json:"atProvider,omitempty"` }
PolicyStatus defines the observed state of Policy.
func (*PolicyStatus) DeepCopy ¶
func (in *PolicyStatus) DeepCopy() *PolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyStatus.
func (*PolicyStatus) DeepCopyInto ¶
func (in *PolicyStatus) DeepCopyInto(out *PolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RulesObservation ¶
type RulesObservation struct { }
func (*RulesObservation) DeepCopy ¶
func (in *RulesObservation) DeepCopy() *RulesObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RulesObservation.
func (*RulesObservation) DeepCopyInto ¶
func (in *RulesObservation) DeepCopyInto(out *RulesObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RulesParameters ¶
type RulesParameters struct { // Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints. // +kubebuilder:validation:Optional AllowAll *string `json:"allowAll,omitempty" tf:"allow_all,omitempty"` // A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". // +kubebuilder:validation:Optional Condition []ConditionParameters `json:"condition,omitempty" tf:"condition,omitempty"` // Setting this to true means that all values are denied. This field can be set only in Policies for list constraints. // +kubebuilder:validation:Optional DenyAll *string `json:"denyAll,omitempty" tf:"deny_all,omitempty"` // If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. This field can be set only in Policies for boolean constraints. // +kubebuilder:validation:Optional Enforce *string `json:"enforce,omitempty" tf:"enforce,omitempty"` // List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints. // +kubebuilder:validation:Optional Values []ValuesParameters `json:"values,omitempty" tf:"values,omitempty"` }
func (*RulesParameters) DeepCopy ¶
func (in *RulesParameters) DeepCopy() *RulesParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RulesParameters.
func (*RulesParameters) DeepCopyInto ¶
func (in *RulesParameters) DeepCopyInto(out *RulesParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpecObservation ¶
type SpecObservation struct { Etag *string `json:"etag,omitempty" tf:"etag,omitempty"` UpdateTime *string `json:"updateTime,omitempty" tf:"update_time,omitempty"` }
func (*SpecObservation) DeepCopy ¶
func (in *SpecObservation) DeepCopy() *SpecObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpecObservation.
func (*SpecObservation) DeepCopyInto ¶
func (in *SpecObservation) DeepCopyInto(out *SpecObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpecParameters ¶
type SpecParameters struct { // Determines the inheritance behavior for this `Policy`. If `inherit_from_parent` is true, PolicyRules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this Policy becomes the new root for evaluation. This field can be set only for Policies which configure list constraints. // +kubebuilder:validation:Optional InheritFromParent *bool `json:"inheritFromParent,omitempty" tf:"inherit_from_parent,omitempty"` // Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. // +kubebuilder:validation:Optional Reset *bool `json:"reset,omitempty" tf:"reset,omitempty"` // Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply: - There must be one and only one PolicyRule where condition is unset. - BooleanPolicyRules with conditions must set `enforced` to the opposite of the PolicyRule without a condition. - During policy evaluation, PolicyRules with conditions that are true for a target resource take precedence. // +kubebuilder:validation:Optional Rules []RulesParameters `json:"rules,omitempty" tf:"rules,omitempty"` }
func (*SpecParameters) DeepCopy ¶
func (in *SpecParameters) DeepCopy() *SpecParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpecParameters.
func (*SpecParameters) DeepCopyInto ¶
func (in *SpecParameters) DeepCopyInto(out *SpecParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ValuesObservation ¶
type ValuesObservation struct { }
func (*ValuesObservation) DeepCopy ¶
func (in *ValuesObservation) DeepCopy() *ValuesObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValuesObservation.
func (*ValuesObservation) DeepCopyInto ¶
func (in *ValuesObservation) DeepCopyInto(out *ValuesObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ValuesParameters ¶
type ValuesParameters struct { // List of values allowed at this resource. // +kubebuilder:validation:Optional AllowedValues []*string `json:"allowedValues,omitempty" tf:"allowed_values,omitempty"` // List of values denied at this resource. // +kubebuilder:validation:Optional DeniedValues []*string `json:"deniedValues,omitempty" tf:"denied_values,omitempty"` }
func (*ValuesParameters) DeepCopy ¶
func (in *ValuesParameters) DeepCopy() *ValuesParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValuesParameters.
func (*ValuesParameters) DeepCopyInto ¶
func (in *ValuesParameters) DeepCopyInto(out *ValuesParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.