v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the iam v1alpha1 API group +kubebuilder:object:generate=true +k8s:defaulter-gen=TypeMeta +groupName=iam.aws.infrastructure.cluster.x-k8s.io +gencrdrefdocs:force

Package v1alpha1 contains API Schema definitions for the iam v1alpha1 API group +kubebuilder:object:generate=true +k8s:defaulter-gen=TypeMeta +groupName=iam.aws.infrastructure.cluster.x-k8s.io

Index

• Constants
• Variables
• func RegisterDefaults(scheme *runtime.Scheme) error
• type Actions
  • func (in Actions) DeepCopy() Actions
  • func (in Actions) DeepCopyInto(out *Actions)
  • func (actions *Actions) UnmarshalJSON(data []byte) error
• type ConditionOperator
• type Conditions
  • func (in Conditions) DeepCopy() Conditions
  • func (in Conditions) DeepCopyInto(out *Conditions)
• type Effect
• type PolicyDocument
  • func (in *PolicyDocument) DeepCopy() *PolicyDocument
  • func (in *PolicyDocument) DeepCopyInto(out *PolicyDocument)
• type PrincipalID
  • func (in PrincipalID) DeepCopy() PrincipalID
  • func (in PrincipalID) DeepCopyInto(out *PrincipalID)
  • func (identityID *PrincipalID) UnmarshalJSON(data []byte) error
• type PrincipalType
• type Principals
  • func (in Principals) DeepCopy() Principals
  • func (in Principals) DeepCopyInto(out *Principals)
• type Resources
  • func (in Resources) DeepCopy() Resources
  • func (in Resources) DeepCopyInto(out *Resources)
• type StatementEntry
  • func (in *StatementEntry) DeepCopy() *StatementEntry
  • func (in *StatementEntry) DeepCopyInto(out *StatementEntry)
• type Statements
  • func (in Statements) DeepCopy() Statements
  • func (in Statements) DeepCopyInto(out *Statements)

Constants

const (

	// Any is the AWS IAM policy grammar wildcard.
	Any = "*"

	// CurrentVersion is the latest version of the AWS IAM policy grammar.
	CurrentVersion = "2012-10-17"

	// EffectAllow is the Allow effect in an AWS IAM policy statement entry.
	EffectAllow Effect = "Allow"

	// EffectDeny is the Deny effect in an AWS IAM policy statement entry.
	EffectDeny Effect = "Deny"

	// PrincipalAWS is the identity type covering AWS ARNs.
	PrincipalAWS PrincipalType = "AWS"

	// PrincipalFederated is the identity type covering federated identities.
	PrincipalFederated PrincipalType = "Federated"

	// PrincipalService is the identity type covering AWS services.
	PrincipalService PrincipalType = "Service"

	// StringEquals is an AWS IAM policy condition operator.
	StringEquals ConditionOperator = "StringEquals"

	// StringNotEquals is an AWS IAM policy condition operator.
	StringNotEquals ConditionOperator = "StringNotEquals"

	// StringEqualsIgnoreCase is an AWS IAM policy condition operator.
	StringEqualsIgnoreCase ConditionOperator = "StringEqualsIgnoreCase"

	// StringLike is an AWS IAM policy condition operator.
	StringLike ConditionOperator = "StringLike"

	// StringNotLike is an AWS IAM policy condition operator.
	StringNotLike ConditionOperator = "StringNotLike"
)

const GroupName = "iam.aws.infrastructure.cluster.x-k8s.io"

GroupName is the group name used in this package

Variables

var (
	// SchemeGroupVersion is the fully qualified group and version
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = localSchemeBuilder.AddToScheme
)

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

Types

type Actions

type Actions []string

Actions is the list of actions

func (Actions) DeepCopy

func (in Actions) DeepCopy() Actions

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

func (Actions) DeepCopyInto

func (in Actions) DeepCopyInto(out *Actions)

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

func (*Actions) UnmarshalJSON

func (actions *Actions) UnmarshalJSON(data []byte) error

type ConditionOperator

type ConditionOperator string

type Conditions

type Conditions map[ConditionOperator]interface{}

Conditions is the map of all conditions in the statement entry.

func (Conditions) DeepCopy

func (in Conditions) DeepCopy() Conditions

DeepCopy copies the receiver, creating a new Conditions.

func (Conditions) DeepCopyInto

func (in Conditions) DeepCopyInto(out *Conditions)

DeepCopyInto copies the receiver, writing into out. in must be non-nil.

type Effect

type Effect string

type PolicyDocument

type PolicyDocument struct {
	Version   string
	Statement Statements
	ID        string `json:"Id,omitempty"`
}

PolicyDocument represents an AWS IAM policy document, and can be converted into JSON using "sigs.k8s.io/cluster-api-provider-aws/cmd/clusterawsadm/converters"

func (*PolicyDocument) DeepCopy

func (in *PolicyDocument) DeepCopy() *PolicyDocument

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

func (*PolicyDocument) DeepCopyInto

func (in *PolicyDocument) DeepCopyInto(out *PolicyDocument)

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

type PrincipalID

type PrincipalID []string

PrincipalID represents the list of all identities, such as ARNs

func (PrincipalID) DeepCopy

func (in PrincipalID) DeepCopy() PrincipalID

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

func (PrincipalID) DeepCopyInto

func (in PrincipalID) DeepCopyInto(out *PrincipalID)

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

func (*PrincipalID) UnmarshalJSON

func (identityID *PrincipalID) UnmarshalJSON(data []byte) error

type PrincipalType

type PrincipalType string

type Principals

type Principals map[PrincipalType]PrincipalID

Principals is the map of all identities a statement entry refers to

func (Principals) DeepCopy

func (in Principals) DeepCopy() Principals

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

func (Principals) DeepCopyInto

func (in Principals) DeepCopyInto(out *Principals)

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

type Resources

type Resources []string

Resources is the list of resources

func (Resources) DeepCopy

func (in Resources) DeepCopy() Resources

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

func (Resources) DeepCopyInto

func (in Resources) DeepCopyInto(out *Resources)

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

type StatementEntry

type StatementEntry struct {
	Sid          string     `json:",omitempty"`
	Principal    Principals `json:",omitempty"`
	NotPrincipal Principals `json:",omitempty"`
	Effect       Effect     `json:"Effect"`
	Action       Actions    `json:"Action"`
	Resource     Resources  `json:",omitempty"`
	Condition    Conditions `json:"Condition,omitempty"`
}

StatementEntry represents each "statement" block in an AWS IAM policy document.

func (*StatementEntry) DeepCopy

func (in *StatementEntry) DeepCopy() *StatementEntry

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

func (*StatementEntry) DeepCopyInto

func (in *StatementEntry) DeepCopyInto(out *StatementEntry)

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

type Statements

type Statements []StatementEntry

Statements is the list of StatementEntries

func (Statements) DeepCopy

func (in Statements) DeepCopy() Statements

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

func (Statements) DeepCopyInto

func (in Statements) DeepCopyInto(out *Statements)

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