v1beta1

package
v1.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=cloudcontrol.aws.upbound.io +versionName=v1beta1

Index

Constants

View Source
const (
	CRDGroup   = "cloudcontrol.aws.upbound.io"
	CRDVersion = "v1beta1"
)

Package type metadata.

Variables

View Source
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
)
View Source
var (
	Resource_Kind             = "Resource"
	Resource_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Resource_Kind}.String()
	Resource_KindAPIVersion   = Resource_Kind + "." + CRDGroupVersion.String()
	Resource_GroupVersionKind = CRDGroupVersion.WithKind(Resource_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Resource

type Resource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.desiredState) || (has(self.initProvider) && has(self.initProvider.desiredState))",message="spec.forProvider.desiredState is a required parameter"
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.typeName) || (has(self.initProvider) && has(self.initProvider.typeName))",message="spec.forProvider.typeName is a required parameter"
	Spec   ResourceSpec   `json:"spec"`
	Status ResourceStatus `json:"status,omitempty"`
}

Resource is the Schema for the Resources API. Manages a Cloud Control API Resource. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].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:resource:scope=Cluster,categories={crossplane,managed,aws}

func (*Resource) DeepCopy

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Resource) DeepCopyObject

func (in *Resource) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Resource) GetCondition

func (mg *Resource) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Resource.

func (*Resource) GetConnectionDetailsMapping

func (tr *Resource) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Resource

func (*Resource) GetDeletionPolicy

func (mg *Resource) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Resource.

func (*Resource) GetID

func (tr *Resource) GetID() string

GetID returns ID of underlying Terraform resource of this Resource

func (*Resource) GetInitParameters added in v0.38.0

func (tr *Resource) GetInitParameters() (map[string]any, error)

GetInitParameters of this Resource

func (*Resource) GetManagementPolicies added in v0.38.0

func (mg *Resource) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Resource.

func (*Resource) GetMergedParameters added in v0.44.0

func (tr *Resource) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Resource

func (*Resource) GetObservation

func (tr *Resource) GetObservation() (map[string]any, error)

GetObservation of this Resource

func (*Resource) GetParameters

func (tr *Resource) GetParameters() (map[string]any, error)

GetParameters of this Resource

func (*Resource) GetProviderConfigReference

func (mg *Resource) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Resource.

func (*Resource) GetPublishConnectionDetailsTo

func (mg *Resource) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Resource.

func (*Resource) GetTerraformResourceType

func (mg *Resource) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Resource

func (*Resource) GetTerraformSchemaVersion

func (tr *Resource) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Resource) GetWriteConnectionSecretToReference

func (mg *Resource) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Resource.

func (*Resource) Hub added in v0.47.2

func (tr *Resource) Hub()

Hub marks this type as a conversion hub.

func (*Resource) LateInitialize

func (tr *Resource) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Resource using its observed tfState. returns True if there are any spec changes for the resource.

func (*Resource) ResolveReferences

func (mg *Resource) ResolveReferences(ctx context.Context, c client.Reader) error

func (*Resource) SetConditions

func (mg *Resource) SetConditions(c ...xpv1.Condition)

SetConditions of this Resource.

func (*Resource) SetDeletionPolicy

func (mg *Resource) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Resource.

func (*Resource) SetManagementPolicies added in v0.38.0

func (mg *Resource) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Resource.

func (*Resource) SetObservation

func (tr *Resource) SetObservation(obs map[string]any) error

SetObservation for this Resource

func (*Resource) SetParameters

func (tr *Resource) SetParameters(params map[string]any) error

SetParameters for this Resource

func (*Resource) SetProviderConfigReference

func (mg *Resource) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Resource.

func (*Resource) SetPublishConnectionDetailsTo

func (mg *Resource) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Resource.

func (*Resource) SetWriteConnectionSecretToReference

func (mg *Resource) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Resource.

type ResourceInitParameters added in v0.38.0

type ResourceInitParameters struct {

	// JSON string matching the CloudFormation resource type schema with desired configuration.
	DesiredState *string `json:"desiredState,omitempty" tf:"desired_state,omitempty"`

	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	// +crossplane:generate:reference:type=github.com/upbound/provider-aws/apis/iam/v1beta1.Role
	// +crossplane:generate:reference:extractor=github.com/upbound/provider-aws/config/common.ARNExtractor()
	RoleArn *string `json:"roleArn,omitempty" tf:"role_arn,omitempty"`

	// Reference to a Role in iam to populate roleArn.
	// +kubebuilder:validation:Optional
	RoleArnRef *v1.Reference `json:"roleArnRef,omitempty" tf:"-"`

	// Selector for a Role in iam to populate roleArn.
	// +kubebuilder:validation:Optional
	RoleArnSelector *v1.Selector `json:"roleArnSelector,omitempty" tf:"-"`

	// JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same type_name, it is recommended to fetch the schema once via the aws_cloudformation_type data source and use this argument to reduce DescribeType API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
	SchemaSecretRef *v1.SecretKeySelector `json:"schemaSecretRef,omitempty" tf:"-"`

	// CloudFormation resource type name. For example, AWS::EC2::VPC.
	TypeName *string `json:"typeName,omitempty" tf:"type_name,omitempty"`

	// Identifier of the CloudFormation resource type version.
	TypeVersionID *string `json:"typeVersionId,omitempty" tf:"type_version_id,omitempty"`
}

func (*ResourceInitParameters) DeepCopy added in v0.38.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceInitParameters.

func (*ResourceInitParameters) DeepCopyInto added in v0.38.0

func (in *ResourceInitParameters) DeepCopyInto(out *ResourceInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceList

type ResourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Resource `json:"items"`
}

ResourceList contains a list of Resources

func (*ResourceList) DeepCopy

func (in *ResourceList) DeepCopy() *ResourceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceList.

func (*ResourceList) DeepCopyInto

func (in *ResourceList) DeepCopyInto(out *ResourceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceList) DeepCopyObject

func (in *ResourceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ResourceList) GetItems

func (l *ResourceList) GetItems() []resource.Managed

GetItems of this ResourceList.

type ResourceObservation

type ResourceObservation struct {

	// JSON string matching the CloudFormation resource type schema with desired configuration.
	DesiredState *string `json:"desiredState,omitempty" tf:"desired_state,omitempty"`

	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the jsondecode() function, for example, jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"].
	Properties *string `json:"properties,omitempty" tf:"properties,omitempty"`

	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	RoleArn *string `json:"roleArn,omitempty" tf:"role_arn,omitempty"`

	// CloudFormation resource type name. For example, AWS::EC2::VPC.
	TypeName *string `json:"typeName,omitempty" tf:"type_name,omitempty"`

	// Identifier of the CloudFormation resource type version.
	TypeVersionID *string `json:"typeVersionId,omitempty" tf:"type_version_id,omitempty"`
}

func (*ResourceObservation) DeepCopy

func (in *ResourceObservation) DeepCopy() *ResourceObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceObservation.

func (*ResourceObservation) DeepCopyInto

func (in *ResourceObservation) DeepCopyInto(out *ResourceObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceParameters

type ResourceParameters struct {

	// JSON string matching the CloudFormation resource type schema with desired configuration.
	// +kubebuilder:validation:Optional
	DesiredState *string `json:"desiredState,omitempty" tf:"desired_state,omitempty"`

	// Region is the region you'd like your resource to be created in.
	// +upjet:crd:field:TFTag=-
	// +kubebuilder:validation:Required
	Region *string `json:"region" tf:"-"`

	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	// +crossplane:generate:reference:type=github.com/upbound/provider-aws/apis/iam/v1beta1.Role
	// +crossplane:generate:reference:extractor=github.com/upbound/provider-aws/config/common.ARNExtractor()
	// +kubebuilder:validation:Optional
	RoleArn *string `json:"roleArn,omitempty" tf:"role_arn,omitempty"`

	// Reference to a Role in iam to populate roleArn.
	// +kubebuilder:validation:Optional
	RoleArnRef *v1.Reference `json:"roleArnRef,omitempty" tf:"-"`

	// Selector for a Role in iam to populate roleArn.
	// +kubebuilder:validation:Optional
	RoleArnSelector *v1.Selector `json:"roleArnSelector,omitempty" tf:"-"`

	// JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same type_name, it is recommended to fetch the schema once via the aws_cloudformation_type data source and use this argument to reduce DescribeType API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
	// +kubebuilder:validation:Optional
	SchemaSecretRef *v1.SecretKeySelector `json:"schemaSecretRef,omitempty" tf:"-"`

	// CloudFormation resource type name. For example, AWS::EC2::VPC.
	// +kubebuilder:validation:Optional
	TypeName *string `json:"typeName,omitempty" tf:"type_name,omitempty"`

	// Identifier of the CloudFormation resource type version.
	// +kubebuilder:validation:Optional
	TypeVersionID *string `json:"typeVersionId,omitempty" tf:"type_version_id,omitempty"`
}

func (*ResourceParameters) DeepCopy

func (in *ResourceParameters) DeepCopy() *ResourceParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceParameters.

func (*ResourceParameters) DeepCopyInto

func (in *ResourceParameters) DeepCopyInto(out *ResourceParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceSpec

type ResourceSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     ResourceParameters `json:"forProvider"`
	// 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.
	InitProvider ResourceInitParameters `json:"initProvider,omitempty"`
}

ResourceSpec defines the desired state of Resource

func (*ResourceSpec) DeepCopy

func (in *ResourceSpec) DeepCopy() *ResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.

func (*ResourceSpec) DeepCopyInto

func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceStatus

type ResourceStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        ResourceObservation `json:"atProvider,omitempty"`
}

ResourceStatus defines the observed state of Resource.

func (*ResourceStatus) DeepCopy

func (in *ResourceStatus) DeepCopy() *ResourceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceStatus.

func (*ResourceStatus) DeepCopyInto

func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL