v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the apigateway v1alpha1 API group +kubebuilder:object:generate=true +groupName=meta.awsctrl.io

Index

• Variables
• type CloudFormationMeta
  • func (in *CloudFormationMeta) DeepCopy() *CloudFormationMeta
  • func (in *CloudFormationMeta) DeepCopyInto(out *CloudFormationMeta)
• type ConditionStatus
• type FailureEvent
• type ObjectRef
  • func (in *ObjectRef) DeepCopy() *ObjectRef
  • func (in *ObjectRef) DeepCopyInto(out *ObjectRef)
• type ObjectReference
  • func (in *ObjectReference) DeepCopy() *ObjectReference
  • func (in *ObjectReference) DeepCopyInto(out *ObjectReference)
  • func (so *ObjectReference) Empty() bool
  • func (so *ObjectReference) String(client dynamic.Interface) (string, error)
• type StatusMeta
  • func (in *StatusMeta) DeepCopy() *StatusMeta
  • func (in *StatusMeta) DeepCopyInto(out *StatusMeta)
• type Tag
  • func (in *Tag) DeepCopy() *Tag
  • func (in *Tag) DeepCopyInto(out *Tag)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "meta.awsctrl.io", Version: "v1alpha1"}
	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type CloudFormationMeta

type CloudFormationMeta struct {
	// +optional
	StackName string `json:"stackName,omitempty"`

	// +optional
	Region string `json:"region,omitempty"`

	// +optional
	// NotificationARNs the Simple Notification Service (SNS) topic ARNs to
	// publish stack related events.
	NotificationARNs []*string `json:"notificationARNs,omitempty"`

	// Capabilities In some cases, you must explicity acknowledge that your stack
	// template contains certain capabilities in order for AWS CloudFormation to
	// create the stack.
	// +optional
	Capabilities []*string `json:"capabilities,omitempty"`

	// +optional
	// OnFailure determines what action will be taken if stack creation fails.
	// This must be one of: DO_NOTHING, ROLLBACK, or DELETE.
	OnFailure string `json:"onFailure,omitempty"`

	// Tags key-value pairs to associate with this stack. AWS CloudFormation also
	// propagates these tags to the resources created in the stack.
	// +optional
	Tags map[string]string `json:"tags,omitempty"`

	// TerminationProtection whether to enable termination protection on
	// the specified stack. If a user attempts to delete a stack with termination
	// protection enabled, the operation fails and the stack remains unchanged.
	// +optional
	TerminationProtection bool `json:"terminationProtection,omitempty"`
}

CloudFormationMeta is the default CloudFormation spec metadata

func (*CloudFormationMeta) DeepCopy

func (in *CloudFormationMeta) DeepCopy() *CloudFormationMeta

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

func (*CloudFormationMeta) DeepCopyInto

func (in *CloudFormationMeta) DeepCopyInto(out *CloudFormationMeta)

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

type ConditionStatus

type ConditionStatus string

ConditionStatus is the current condition status

const (
	// CreateCompleteStatus represents CREATE_COMPLETE CloudFormation status
	CreateCompleteStatus ConditionStatus = "CreateComplete"

	// CreateInProgressStatus represents CREATE_IN_PROGRESS CloudFormation status
	CreateInProgressStatus ConditionStatus = "CreateInProgress"

	// CreateFailedStatus represents CREATE_FAILED CloudFormation status
	CreateFailedStatus ConditionStatus = "CreateFailed"

	// DeleteCompleteStatus represents DELETE_COMPLETE CloudFormation status
	DeleteCompleteStatus ConditionStatus = "DeleteComplete"

	// DeleteFailedStatus represents DELETE_FAILED CloudFormation status
	DeleteFailedStatus ConditionStatus = "DeleteFailed"

	// DeleteInProgressStatus represents DELETE_IN_PROGRESS CloudFormation status
	DeleteInProgressStatus ConditionStatus = "DeleteInProgress"

	// ReviewInProgressStatus represents REVIEW_IN_PROGRESS CloudFormation status
	ReviewInProgressStatus ConditionStatus = "ReviewInProgress"

	// RollbackCompleteStatus represents ROLLBACK_COMPLETE CloudFormation status
	RollbackCompleteStatus ConditionStatus = "RollbackComplete"

	// RollbackFailedStatus represents ROLLBACK_FAILED CloudFormation status
	RollbackFailedStatus ConditionStatus = "RollbackFailed"

	// RollbackInProgressStatus represents ROLLBACK_IN_PROGRESS CloudFormation status
	RollbackInProgressStatus ConditionStatus = "RollbackInProgress"

	// UpdateCompleteStatus represents UPDATE_COMPLETE CloudFormation status
	UpdateCompleteStatus ConditionStatus = "UpdateComplete"

	// UpdateCompleteCleanupInProgressStatus represents UPDATE_COMPLETE_CLEANUP_IN_PROGRESS CloudFormation status
	UpdateCompleteCleanupInProgressStatus ConditionStatus = "UpdateCompleteCleanupInProgress"

	// UpdateInProgressStatus represents UPDATE_IN_PROGRESS CloudFormation status
	UpdateInProgressStatus ConditionStatus = "UpdateInProgress"

	// UpdateRollbackCompleteStatus represents UPDATE_ROLLBACK_COMPLETE CloudFormation status
	UpdateRollbackCompleteStatus ConditionStatus = "UpdateRollbackComplete"

	// UpdateRollbackCompleteCleanupInProgressStatus represents UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS CloudFormation status
	UpdateRollbackCompleteCleanupInProgressStatus ConditionStatus = "UpdateRollbackCompleteCleanupInProgress"

	// UpdateRollbackFailedStatus represents UPDATE_ROLLBACK_FAILED CloudFormation status
	UpdateRollbackFailedStatus ConditionStatus = "UpdateRollbackFailed"

	// UpdateRollbackInProgressStatus represents UPDATE_ROLLBACK_IN_PROGRESS CloudFormation status
	UpdateRollbackInProgressStatus ConditionStatus = "UpdateRollbackInProgress"
)

type FailureEvent

type FailureEvent string

FailureEvent describes what a stack does on failure

const (
	// DoNothingFailureEvent When a stack fails don't do anything, this leaves the previously created resources
	DoNothingFailureEvent FailureEvent = "DO_NOTHING"

	// RollbackFailureEvent When a stack fails rollback all resources but leave the stack
	RollbackFailureEvent FailureEvent = "ROLLBACK"

	// DeleteFailureEvent When a stack fails delete the stack and all resources, DEFAULT action,
	// this allows the control loop to continue retrying automatically
	DeleteFailureEvent FailureEvent = "DELETE"
)

type ObjectRef

type ObjectRef struct {
	// API version of the referent.
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind of the referent.
	Kind string `json:"kind,omitempty"`

	// Name of the referent.
	Name string `json:"name,omitempty"`

	// Namespace of the referent.
	Namespace string `json:"namespace,omitempty"`

	// Key of the referent.
	Key string `json:"key,omitempty"`
}

ObjectRef gives pointers to the object key it should use

func (*ObjectRef) DeepCopy

func (in *ObjectRef) DeepCopy() *ObjectRef

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

func (*ObjectRef) DeepCopyInto

func (in *ObjectRef) DeepCopyInto(out *ObjectRef)

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

type ObjectReference

type ObjectReference struct {
	// ObjectRef references another stack
	ObjectRef `json:",inline"`

	// Id is used if the object expects an ID like Security groups and vpcs
	Id string `json:"id,omitempty"`

	// Arn is used if the object expects an Arn
	Arn string `json:"arn,omitempty"`
}

ObjectReference contains information about how

func (*ObjectReference) DeepCopy

func (in *ObjectReference) DeepCopy() *ObjectReference

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

func (*ObjectReference) DeepCopyInto

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

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

func (*ObjectReference) Empty

func (so *ObjectReference) Empty() bool

Empty will allow controllers to ignore these references

func (*ObjectReference) String

func (so *ObjectReference) String(client dynamic.Interface) (string, error)

String will return stack object string TODO(christopherhein) This overall will need to be updated to make sure that the person has RBAC or something to allow this to happen

type StatusMeta

type StatusMeta struct {
	// ObservedGeneration is the version of the manifest which has been applied
	// +optional
	ObservedGeneration int64 `json:"generation,omitempty"`

	// Status is the status of the condition
	// +optional
	Status ConditionStatus `json:"status,omitempty"`

	// +optional
	Message *string `json:"message,omitempty,omitempty"`

	// +optional
	LastHeartbeatTime *metav1.Time `json:"lastHeartbeatTime,omitempty"`

	// +optional
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`

	// +optional
	StackID string `json:"stackID,omitempty"`

	// +optional
	StackName string `json:"stackName,omitempty"`

	// +optional
	Outputs map[string]string `json:"outputs,omitempty"`
}

StatusMeta is the default CloudFormation status metadata

func (*StatusMeta) DeepCopy

func (in *StatusMeta) DeepCopy() *StatusMeta

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

func (*StatusMeta) DeepCopyInto

func (in *StatusMeta) DeepCopyInto(out *StatusMeta)

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

type Tag

type Tag struct {
	// Key labels the tag
	Key string `json:"key"`

	// Value stores the value for the key
	Value string `json:"value"`
}

Tag stores keys and values for tagging

func (*Tag) DeepCopy

func (in *Tag) DeepCopy() *Tag

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

func (*Tag) DeepCopyInto

func (in *Tag) DeepCopyInto(out *Tag)

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