Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the ram.services.k8s.aws API. +groupName=ram.services.k8s.aws
Index ¶
- Variables
- type AssociatedPermission
- type PermissionFeatureSet
- type PermissionStatus
- type PermissionType
- type PermissionTypeFilter
- type Principal
- type ReplacePermissionAssociationsWork
- type ReplacePermissionAssociationsWorkStatus
- type Resource
- type ResourceOwner
- type ResourceRegionScope
- type ResourceRegionScopeFilter
- type ResourceShare
- type ResourceShareAssociation
- type ResourceShareAssociationStatus
- type ResourceShareAssociationType
- type ResourceShareFeatureSet
- type ResourceShareInvitation
- type ResourceShareInvitationStatus
- type ResourceShareList
- type ResourceSharePermissionDetail
- type ResourceSharePermissionSummary
- type ResourceShareSpec
- type ResourceShareStatus
- type ResourceShareStatus_SDK
- type ResourceShare_SDK
- type ResourceStatus
- type ServiceNameAndResourceType
- type Tag
- type TagFilter
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "ram.services.k8s.aws", 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 )
Functions ¶
This section is empty.
Types ¶
type AssociatedPermission ¶
type AssociatedPermission struct {
ARN *string `json:"arn,omitempty"`
DefaultVersion *bool `json:"defaultVersion,omitempty"`
LastUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
PermissionVersion *string `json:"permissionVersion,omitempty"`
ResourceType *string `json:"resourceType,omitempty"`
Status *string `json:"status,omitempty"`
}
An object that describes a managed permission associated with a resource share.
func (*AssociatedPermission) DeepCopy ¶
func (in *AssociatedPermission) DeepCopy() *AssociatedPermission
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AssociatedPermission.
func (*AssociatedPermission) DeepCopyInto ¶
func (in *AssociatedPermission) DeepCopyInto(out *AssociatedPermission)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PermissionFeatureSet ¶
type PermissionFeatureSet string
const ( PermissionFeatureSet_CREATED_FROM_POLICY PermissionFeatureSet = "CREATED_FROM_POLICY" PermissionFeatureSet_PROMOTING_TO_STANDARD PermissionFeatureSet = "PROMOTING_TO_STANDARD" PermissionFeatureSet_STANDARD PermissionFeatureSet = "STANDARD" )
type PermissionStatus ¶
type PermissionStatus string
const ( PermissionStatus_ATTACHABLE PermissionStatus = "ATTACHABLE" PermissionStatus_UNATTACHABLE PermissionStatus = "UNATTACHABLE" PermissionStatus_DELETING PermissionStatus = "DELETING" PermissionStatus_DELETED PermissionStatus = "DELETED" )
type PermissionType ¶
type PermissionType string
const ( PermissionType_CUSTOMER_MANAGED PermissionType = "CUSTOMER_MANAGED" PermissionType_AWS_MANAGED PermissionType = "AWS_MANAGED" )
type PermissionTypeFilter ¶
type PermissionTypeFilter string
const ( PermissionTypeFilter_ALL PermissionTypeFilter = "ALL" PermissionTypeFilter_AWS_MANAGED PermissionTypeFilter = "AWS_MANAGED" PermissionTypeFilter_CUSTOMER_MANAGED PermissionTypeFilter = "CUSTOMER_MANAGED" )
type Principal ¶
type Principal struct {
CreationTime *metav1.Time `json:"creationTime,omitempty"`
External *bool `json:"external,omitempty"`
ID *string `json:"id,omitempty"`
LastUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
}
Describes a principal for use with Resource Access Manager.
func (*Principal) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Principal.
func (*Principal) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReplacePermissionAssociationsWork ¶
type ReplacePermissionAssociationsWork struct {
CreationTime *metav1.Time `json:"creationTime,omitempty"`
FromPermissionARN *string `json:"fromPermissionARN,omitempty"`
FromPermissionVersion *string `json:"fromPermissionVersion,omitempty"`
ID *string `json:"id,omitempty"`
LastUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
StatusMessage *string `json:"statusMessage,omitempty"`
ToPermissionARN *string `json:"toPermissionARN,omitempty"`
ToPermissionVersion *string `json:"toPermissionVersion,omitempty"`
}
A structure that represents the background work that RAM performs when you invoke the ReplacePermissionAssociations operation.
func (*ReplacePermissionAssociationsWork) DeepCopy ¶
func (in *ReplacePermissionAssociationsWork) DeepCopy() *ReplacePermissionAssociationsWork
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplacePermissionAssociationsWork.
func (*ReplacePermissionAssociationsWork) DeepCopyInto ¶
func (in *ReplacePermissionAssociationsWork) DeepCopyInto(out *ReplacePermissionAssociationsWork)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReplacePermissionAssociationsWorkStatus ¶
type ReplacePermissionAssociationsWorkStatus string
const ( ReplacePermissionAssociationsWorkStatus_IN_PROGRESS ReplacePermissionAssociationsWorkStatus = "IN_PROGRESS" ReplacePermissionAssociationsWorkStatus_COMPLETED ReplacePermissionAssociationsWorkStatus = "COMPLETED" ReplacePermissionAssociationsWorkStatus_FAILED ReplacePermissionAssociationsWorkStatus = "FAILED" )
type Resource ¶
type Resource struct {
ARN *string `json:"arn,omitempty"`
CreationTime *metav1.Time `json:"creationTime,omitempty"`
LastUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
ResourceGroupARN *string `json:"resourceGroupARN,omitempty"`
StatusMessage *string `json:"statusMessage,omitempty"`
Type *string `json:"type_,omitempty"`
}
Describes a resource associated with a resource share in RAM.
func (*Resource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.
func (*Resource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceOwner ¶
type ResourceOwner string
const ( ResourceOwner_SELF ResourceOwner = "SELF" ResourceOwner_OTHER_ACCOUNTS ResourceOwner = "OTHER-ACCOUNTS" )
type ResourceRegionScope ¶
type ResourceRegionScope string
const ( ResourceRegionScope_REGIONAL ResourceRegionScope = "REGIONAL" ResourceRegionScope_GLOBAL ResourceRegionScope = "GLOBAL" )
type ResourceRegionScopeFilter ¶
type ResourceRegionScopeFilter string
const ( ResourceRegionScopeFilter_ALL ResourceRegionScopeFilter = "ALL" ResourceRegionScopeFilter_REGIONAL ResourceRegionScopeFilter = "REGIONAL" ResourceRegionScopeFilter_GLOBAL ResourceRegionScopeFilter = "GLOBAL" )
type ResourceShare ¶
type ResourceShare struct {
}
ResourceShare is the Schema for the ResourceShares API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*ResourceShare) DeepCopy ¶
func (in *ResourceShare) DeepCopy() *ResourceShare
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShare.
func (*ResourceShare) DeepCopyInto ¶
func (in *ResourceShare) DeepCopyInto(out *ResourceShare)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ResourceShare) DeepCopyObject ¶
func (in *ResourceShare) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ResourceShareAssociation ¶
type ResourceShareAssociation struct {
}
Describes an association between a resource share and either a principal or a resource.
func (*ResourceShareAssociation) DeepCopy ¶
func (in *ResourceShareAssociation) DeepCopy() *ResourceShareAssociation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShareAssociation.
func (*ResourceShareAssociation) DeepCopyInto ¶
func (in *ResourceShareAssociation) DeepCopyInto(out *ResourceShareAssociation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceShareInvitation ¶
type ResourceShareInvitation struct {
}
Describes an invitation for an Amazon Web Services account to join a resource share.
func (*ResourceShareInvitation) DeepCopy ¶
func (in *ResourceShareInvitation) DeepCopy() *ResourceShareInvitation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShareInvitation.
func (*ResourceShareInvitation) DeepCopyInto ¶
func (in *ResourceShareInvitation) DeepCopyInto(out *ResourceShareInvitation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceShareList ¶
type ResourceShareList struct {
}
ResourceShareList contains a list of ResourceShare +kubebuilder:object:root=true
func (*ResourceShareList) DeepCopy ¶
func (in *ResourceShareList) DeepCopy() *ResourceShareList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShareList.
func (*ResourceShareList) DeepCopyInto ¶
func (in *ResourceShareList) DeepCopyInto(out *ResourceShareList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ResourceShareList) DeepCopyObject ¶
func (in *ResourceShareList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ResourceSharePermissionDetail ¶
type ResourceSharePermissionDetail struct {
}
Information about a RAM managed permission.
func (*ResourceSharePermissionDetail) DeepCopy ¶
func (in *ResourceSharePermissionDetail) DeepCopy() *ResourceSharePermissionDetail
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSharePermissionDetail.
func (*ResourceSharePermissionDetail) DeepCopyInto ¶
func (in *ResourceSharePermissionDetail) DeepCopyInto(out *ResourceSharePermissionDetail)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceSharePermissionSummary ¶
type ResourceSharePermissionSummary struct {
}
Information about an RAM permission.
func (*ResourceSharePermissionSummary) DeepCopy ¶
func (in *ResourceSharePermissionSummary) DeepCopy() *ResourceSharePermissionSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSharePermissionSummary.
func (*ResourceSharePermissionSummary) DeepCopyInto ¶
func (in *ResourceSharePermissionSummary) DeepCopyInto(out *ResourceSharePermissionSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceShareSpec ¶
type ResourceShareSpec struct {
// be associated with a resource share. A value of true lets you share with
// individual Amazon Web Services accounts that are not in your organization.
// A value of false only has meaning if your account is a member of an Amazon
// Web Services Organization. The default value is true.
AllowExternalPrincipals *bool `json:"allowExternalPrincipals,omitempty"`
// +kubebuilder:validation:Required
Name *string `json:"name"`
// of the RAM permission to associate with the resource share. If you do not
// specify an ARN for the permission, RAM automatically attaches the default
// version of the permission for each resource type. You can associate only
// one permission with each resource type included in the resource share.
PermissionARNs []*string `json:"permissionARNs,omitempty"`
// share.
//
// You can include the following values:
//
// - An Amazon Web Services account ID, for example: 123456789012
//
// - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
//
// - An ARN of an organizational unit (OU) in Organizations, for example:
// organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
//
// - An ARN of an IAM role, for example: iam::123456789012:role/rolename
//
// - An ARN of an IAM user, for example: iam::123456789012user/username
//
// Not all resource types can be shared with IAM roles and users. For more information,
// see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
// in the Resource Access Manager User Guide.
Principals []*string `json:"principals,omitempty"`
// resource share.
ResourceARNs []*string `json:"resourceARNs,omitempty"`
// the resources in this resource share.
Sources []*string `json:"sources,omitempty"`
// and not be an empty string. The tag value must be present but can be an empty
// string.
Tags []*Tag `json:"tags,omitempty"`
}
ResourceShareSpec defines the desired state of ResourceShare.
Describes a resource share in RAM.
func (*ResourceShareSpec) DeepCopy ¶
func (in *ResourceShareSpec) DeepCopy() *ResourceShareSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShareSpec.
func (*ResourceShareSpec) DeepCopyInto ¶
func (in *ResourceShareSpec) DeepCopyInto(out *ResourceShareSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceShareStatus ¶
type ResourceShareStatus struct {
// that is used to contain resource sync state, account ownership,
// constructed ARN for the resource
// +kubebuilder:validation:Optional
ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
// contains a collection of `ackv1alpha1.Condition` objects that describe
// the various terminal states of the CR and its backend AWS service API
// resource
// +kubebuilder:validation:Optional
Conditions []*ackv1alpha1.Condition `json:"conditions"`
// +kubebuilder:validation:Optional
CreationTime *metav1.Time `json:"creationTime,omitempty"`
// can have one of the following values:
//
// * STANDARD – A resource share that supports all functionality. These
// resource shares are visible to all principals you share the resource share
// with. You can modify these resource shares in RAM using the console or
// APIs. This resource share might have been created by RAM, or it might
// have been CREATED_FROM_POLICY and then promoted.
//
// * CREATED_FROM_POLICY – The customer manually shared a resource by attaching
// a resource-based policy. That policy did not match any existing managed
// permissions, so RAM created this customer managed permission automatically
// on the customer's behalf based on the attached policy document. This type
// of resource share is visible only to the Amazon Web Services account that
// created it. You can't modify it in RAM unless you promote it. For more
// information, see PromoteResourceShareCreatedFromPolicy.
//
// * PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY,
// but the customer ran the PromoteResourceShareCreatedFromPolicy and that
// operation is still in progress. This value changes to STANDARD when complete.
// +kubebuilder:validation:Optional
FeatureSet *string `json:"featureSet,omitempty"`
// +kubebuilder:validation:Optional
LastUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
// +kubebuilder:validation:Optional
OwningAccountID *string `json:"owningAccountID,omitempty"`
// +kubebuilder:validation:Optional
Status *string `json:"status,omitempty"`
// +kubebuilder:validation:Optional
StatusMessage *string `json:"statusMessage,omitempty"`
}
ResourceShareStatus defines the observed state of ResourceShare
func (*ResourceShareStatus) DeepCopy ¶
func (in *ResourceShareStatus) DeepCopy() *ResourceShareStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShareStatus.
func (*ResourceShareStatus) DeepCopyInto ¶
func (in *ResourceShareStatus) DeepCopyInto(out *ResourceShareStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceShare_SDK ¶
type ResourceShare_SDK struct {
}
Describes a resource share in RAM.
func (*ResourceShare_SDK) DeepCopy ¶
func (in *ResourceShare_SDK) DeepCopy() *ResourceShare_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceShare_SDK.
func (*ResourceShare_SDK) DeepCopyInto ¶
func (in *ResourceShare_SDK) DeepCopyInto(out *ResourceShare_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceStatus ¶
type ResourceStatus string
const ( ResourceStatus_AVAILABLE ResourceStatus = "AVAILABLE" ResourceStatus_ZONAL_RESOURCE_INACCESSIBLE ResourceStatus = "ZONAL_RESOURCE_INACCESSIBLE" ResourceStatus_LIMIT_EXCEEDED ResourceStatus = "LIMIT_EXCEEDED" ResourceStatus_UNAVAILABLE ResourceStatus = "UNAVAILABLE" ResourceStatus_PENDING ResourceStatus = "PENDING" )
type ServiceNameAndResourceType ¶
type ServiceNameAndResourceType struct {
ResourceType *string `json:"resourceType,omitempty"`
ServiceName *string `json:"serviceName,omitempty"`
}
Information about a shareable resource type and the Amazon Web Services service to which resources of that type belong.
func (*ServiceNameAndResourceType) DeepCopy ¶
func (in *ServiceNameAndResourceType) DeepCopy() *ServiceNameAndResourceType
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceNameAndResourceType.
func (*ServiceNameAndResourceType) DeepCopyInto ¶
func (in *ServiceNameAndResourceType) DeepCopyInto(out *ServiceNameAndResourceType)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tag ¶
A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).
For more information about tags, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference Guide.
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TagFilter ¶
type TagFilter struct {
TagKey *string `json:"tagKey,omitempty"`
TagValues []*string `json:"tagValues,omitempty"`
}
A tag key and optional list of possible values that you can use to filter results for tagged resources.
func (*TagFilter) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TagFilter.
func (*TagFilter) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.