Documentation
¶
Index ¶
- Constants
- Variables
- type AmbiguousRoleResolutionType
- type CustomIdentityPoolParameters
- type ErrorCode
- type IdentityPool
- func (in *IdentityPool) DeepCopy() *IdentityPool
- func (in *IdentityPool) DeepCopyInto(out *IdentityPool)
- func (in *IdentityPool) DeepCopyObject() runtime.Object
- func (mg *IdentityPool) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (mg *IdentityPool) GetDeletionPolicy() xpv1.DeletionPolicy
- func (mg *IdentityPool) GetManagementPolicies() xpv1.ManagementPolicies
- func (mg *IdentityPool) GetProviderConfigReference() *xpv1.Reference
- func (mg *IdentityPool) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *IdentityPool) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (mg *IdentityPool) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *IdentityPool) SetConditions(c ...xpv1.Condition)
- func (mg *IdentityPool) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *IdentityPool) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (mg *IdentityPool) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *IdentityPool) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *IdentityPool) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type IdentityPoolList
- type IdentityPoolObservation
- type IdentityPoolParameters
- type IdentityPoolShortDescription
- type IdentityPoolSpec
- type IdentityPoolStatus
- type MappingRule
- type MappingRuleMatchType
- type Provider
- type RoleMappingType
Constants ¶
const ( CRDGroup = "cognitoidentity.aws.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // 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 )
var ( IdentityPoolKind = "IdentityPool" IdentityPoolGroupKind = schema.GroupKind{Group: CRDGroup, Kind: IdentityPoolKind}.String() IdentityPoolKindAPIVersion = IdentityPoolKind + "." + GroupVersion.String() IdentityPoolGroupVersionKind = GroupVersion.WithKind(IdentityPoolKind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type AmbiguousRoleResolutionType ¶
type AmbiguousRoleResolutionType string
const ( AmbiguousRoleResolutionType_AuthenticatedRole AmbiguousRoleResolutionType = "AuthenticatedRole" AmbiguousRoleResolutionType_Deny AmbiguousRoleResolutionType = "Deny" )
type CustomIdentityPoolParameters ¶
type CustomIdentityPoolParameters struct {
// The Amazon Resource Names (ARN) of the OpenID Connect providers.
// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-aws/apis/iam/v1beta1.OpenIDConnectProvider
// +crossplane:generate:reference:refFieldName=OpenIDConnectProviderARNRefs
// +crossplane:generate:reference:selectorFieldName=OpenIDConnectProviderARNSelector
// +optional
OpenIDConnectProviderARNs []*string `json:"openIdConnectProviderARNs,omitempty"`
// OpenIDConnectProviderARNRefs is a list of references to OpenIDConnectProviderARNs.
// +optional
OpenIDConnectProviderARNRefs []xpv1.Reference `json:"openIdConnectProviderARNRefs,omitempty"`
// OpenIDConnectProviderARNSelector selects references to OpenIDConnectProviderARNs.
// +optional
OpenIDConnectProviderARNSelector *xpv1.Selector `json:"openIdConnectProviderARNSelector,omitempty"`
// An array of Amazon Cognito user pools and their client IDs.
CognitoIdentityProviders []*Provider `json:"cognitoIdentityProviders,omitempty"`
// TRUE if the identity pool supports unauthenticated logins.
// +kubebuilder:validation:Required
AllowUnauthenticatedIdentities *bool `json:"allowUnauthenticatedIdentities"`
}
CustomIdentityPoolParameters includes the custom fields of IdentityPool.
func (*CustomIdentityPoolParameters) DeepCopy ¶
func (in *CustomIdentityPoolParameters) DeepCopy() *CustomIdentityPoolParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomIdentityPoolParameters.
func (*CustomIdentityPoolParameters) DeepCopyInto ¶
func (in *CustomIdentityPoolParameters) DeepCopyInto(out *CustomIdentityPoolParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IdentityPool ¶
type IdentityPool struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec IdentityPoolSpec `json:"spec"`
Status IdentityPoolStatus `json:"status,omitempty"`
}
IdentityPool is the Schema for the IdentityPools 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:storageversion +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws}
func (*IdentityPool) DeepCopy ¶
func (in *IdentityPool) DeepCopy() *IdentityPool
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPool.
func (*IdentityPool) DeepCopyInto ¶
func (in *IdentityPool) DeepCopyInto(out *IdentityPool)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IdentityPool) DeepCopyObject ¶
func (in *IdentityPool) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*IdentityPool) GetCondition ¶
func (mg *IdentityPool) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this IdentityPool.
func (*IdentityPool) GetDeletionPolicy ¶
func (mg *IdentityPool) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this IdentityPool.
func (*IdentityPool) GetManagementPolicies ¶ added in v0.43.0
func (mg *IdentityPool) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this IdentityPool.
func (*IdentityPool) GetProviderConfigReference ¶
func (mg *IdentityPool) GetProviderConfigReference() *xpv1.Reference
GetProviderConfigReference of this IdentityPool.
func (*IdentityPool) GetPublishConnectionDetailsTo ¶
func (mg *IdentityPool) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this IdentityPool.
func (*IdentityPool) GetWriteConnectionSecretToReference ¶
func (mg *IdentityPool) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this IdentityPool.
func (*IdentityPool) ResolveReferences ¶
ResolveReferences of this IdentityPool.
func (*IdentityPool) SetConditions ¶
func (mg *IdentityPool) SetConditions(c ...xpv1.Condition)
SetConditions of this IdentityPool.
func (*IdentityPool) SetDeletionPolicy ¶
func (mg *IdentityPool) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this IdentityPool.
func (*IdentityPool) SetManagementPolicies ¶ added in v0.43.0
func (mg *IdentityPool) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this IdentityPool.
func (*IdentityPool) SetProviderConfigReference ¶
func (mg *IdentityPool) SetProviderConfigReference(r *xpv1.Reference)
SetProviderConfigReference of this IdentityPool.
func (*IdentityPool) SetPublishConnectionDetailsTo ¶
func (mg *IdentityPool) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this IdentityPool.
func (*IdentityPool) SetWriteConnectionSecretToReference ¶
func (mg *IdentityPool) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this IdentityPool.
type IdentityPoolList ¶
type IdentityPoolList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []IdentityPool `json:"items"`
}
IdentityPoolList contains a list of IdentityPools
func (*IdentityPoolList) DeepCopy ¶
func (in *IdentityPoolList) DeepCopy() *IdentityPoolList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolList.
func (*IdentityPoolList) DeepCopyInto ¶
func (in *IdentityPoolList) DeepCopyInto(out *IdentityPoolList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IdentityPoolList) DeepCopyObject ¶
func (in *IdentityPoolList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*IdentityPoolList) GetItems ¶
func (l *IdentityPoolList) GetItems() []resource.Managed
GetItems of this IdentityPoolList.
type IdentityPoolObservation ¶
type IdentityPoolObservation struct {
// TRUE if the identity pool supports unauthenticated logins.
AllowUnauthenticatedIDentities *bool `json:"allowUnauthenticatedIDentities,omitempty"`
// A list representing an Amazon Cognito user pool and its client ID.
CognitoIdentityProviders []*Provider `json:"cognitoIdentityProviders,omitempty"`
// An identity pool ID in the format REGION:GUID.
IdentityPoolID *string `json:"identityPoolID,omitempty"`
// The ARNs of the OpenID Connect providers.
OpenIDConnectProviderARNs []*string `json:"openIDConnectProviderARNs,omitempty"`
}
IdentityPoolObservation defines the observed state of IdentityPool
func (*IdentityPoolObservation) DeepCopy ¶
func (in *IdentityPoolObservation) DeepCopy() *IdentityPoolObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolObservation.
func (*IdentityPoolObservation) DeepCopyInto ¶
func (in *IdentityPoolObservation) DeepCopyInto(out *IdentityPoolObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IdentityPoolParameters ¶
type IdentityPoolParameters struct {
// Region is which region the IdentityPool will be created.
// +kubebuilder:validation:Required
Region string `json:"region"`
// Enables or disables the Basic (Classic) authentication flow. For more information,
// see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html)
// in the Amazon Cognito Developer Guide.
AllowClassicFlow *bool `json:"allowClassicFlow,omitempty"`
// The "domain" by which Cognito will refer to your users. This name acts as
// a placeholder that allows your backend and the Cognito service to communicate
// about the developer provider. For the DeveloperProviderName, you can use
// letters as well as period (.), underscore (_), and dash (-).
//
// Once you have set a developer provider name, you cannot change it. Please
// take care in setting this parameter.
DeveloperProviderName *string `json:"developerProviderName,omitempty"`
// A string that you provide.
// +kubebuilder:validation:Required
IdentityPoolName *string `json:"identityPoolName"`
// Tags to assign to the identity pool. A tag is a label that you can apply
// to identity pools to categorize and manage them in different ways, such as
// by purpose, owner, environment, or other criteria.
IdentityPoolTags map[string]*string `json:"identityPoolTags,omitempty"`
// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
// pool.
SamlProviderARNs []*string `json:"samlProviderARNs,omitempty"`
// Optional key:value pairs mapping provider names to provider app IDs.
SupportedLoginProviders map[string]*string `json:"supportedLoginProviders,omitempty"`
CustomIdentityPoolParameters `json:",inline"`
}
IdentityPoolParameters defines the desired state of IdentityPool
func (*IdentityPoolParameters) DeepCopy ¶
func (in *IdentityPoolParameters) DeepCopy() *IdentityPoolParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolParameters.
func (*IdentityPoolParameters) DeepCopyInto ¶
func (in *IdentityPoolParameters) DeepCopyInto(out *IdentityPoolParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IdentityPoolShortDescription ¶
type IdentityPoolShortDescription struct {
IdentityPoolID *string `json:"identityPoolID,omitempty"`
IdentityPoolName *string `json:"identityPoolName,omitempty"`
}
+kubebuilder:skipversion
func (*IdentityPoolShortDescription) DeepCopy ¶
func (in *IdentityPoolShortDescription) DeepCopy() *IdentityPoolShortDescription
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolShortDescription.
func (*IdentityPoolShortDescription) DeepCopyInto ¶
func (in *IdentityPoolShortDescription) DeepCopyInto(out *IdentityPoolShortDescription)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IdentityPoolSpec ¶
type IdentityPoolSpec struct {
xpv1.ResourceSpec `json:",inline"`
ForProvider IdentityPoolParameters `json:"forProvider"`
}
IdentityPoolSpec defines the desired state of IdentityPool
func (*IdentityPoolSpec) DeepCopy ¶
func (in *IdentityPoolSpec) DeepCopy() *IdentityPoolSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolSpec.
func (*IdentityPoolSpec) DeepCopyInto ¶
func (in *IdentityPoolSpec) DeepCopyInto(out *IdentityPoolSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IdentityPoolStatus ¶
type IdentityPoolStatus struct {
xpv1.ResourceStatus `json:",inline"`
AtProvider IdentityPoolObservation `json:"atProvider,omitempty"`
}
IdentityPoolStatus defines the observed state of IdentityPool.
func (*IdentityPoolStatus) DeepCopy ¶
func (in *IdentityPoolStatus) DeepCopy() *IdentityPoolStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityPoolStatus.
func (*IdentityPoolStatus) DeepCopyInto ¶
func (in *IdentityPoolStatus) DeepCopyInto(out *IdentityPoolStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MappingRule ¶
type MappingRule struct {
RoleARN *string `json:"roleARN,omitempty"`
}
+kubebuilder:skipversion
func (*MappingRule) DeepCopy ¶
func (in *MappingRule) DeepCopy() *MappingRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MappingRule.
func (*MappingRule) DeepCopyInto ¶
func (in *MappingRule) DeepCopyInto(out *MappingRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MappingRuleMatchType ¶
type MappingRuleMatchType string
const ( MappingRuleMatchType_Equals MappingRuleMatchType = "Equals" MappingRuleMatchType_Contains MappingRuleMatchType = "Contains" MappingRuleMatchType_StartsWith MappingRuleMatchType = "StartsWith" MappingRuleMatchType_NotEqual MappingRuleMatchType = "NotEqual" )
type Provider ¶
type Provider struct {
// The client ID for the Amazon Cognito user pool client.
// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-aws/apis/cognitoidentityprovider/v1alpha1.UserPoolClient
// + optional
ClientID *string `json:"clientId,omitempty"`
// ClientIDRef is a reference to an ClientID.
// +optional
ClientIDRef *xpv1.Reference `json:"clientIdRef,omitempty"`
// ClientIDSelector selects references to ClientID.
// +optional
ClientIDSelector *xpv1.Selector `json:"clientIdSelector,omitempty"`
// The provider name for an Amazon Cognito user pool.
// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-aws/apis/cognitoidentityprovider/v1alpha1.UserPool
// +crossplane:generate:reference:extractor=github.com/crossplane-contrib/provider-aws/apis/cognitoidentityprovider/v1alpha1.UserPoolName()
// +optional
ProviderName *string `json:"providerName,omitempty"`
// ProviderNameRef is a reference to an ProviderName.
// +optional
ProviderNameRef *xpv1.Reference `json:"providerNameRef,omitempty"`
// ProviderNameSelector selects references to ProviderName.
// +optional
ProviderNameSelector *xpv1.Selector `json:"providerNameSelector,omitempty"`
// Whether the server-side token validation is enabled for the identity provider’s token.
// +optional
ServerSideTokenCheck *bool `json:"serverSideTokenCheck,omitempty"`
}
Provider contains information to Cognito UserPools and UserPoolClients +kubebuilder:skipversion
func (*Provider) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Provider.
func (*Provider) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RoleMappingType ¶
type RoleMappingType string
const ( RoleMappingType_Token RoleMappingType = "Token" RoleMappingType_Rules RoleMappingType = "Rules" )