AccessPoint
s3control.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | s3control-controller/apis/v1alpha1#AccessPoint |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | AccessPoint |
| ListKind | AccessPointList |
| Plural | accesspoints |
| Singular | accesspoint |
An access point used to access a bucket.
Spec
accountID: string
bucket: string
bucketAccountID: string
name: string
publicAccessBlockConfiguration:
blockPublicACLs: boolean
blockPublicPolicy: boolean
ignorePublicACLs: boolean
restrictPublicBuckets: boolean
vpcConfiguration:
vpcID: string
| Field | Description |
|---|---|
| accountID Required | string The Amazon Web Services account ID for the account that owns the specified access point. |
| bucket Required | string The name of the bucket that you want to associate this access point with. For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded. |
| bucketAccountID Optional | string The Amazon Web Services account ID associated with the S3 bucket associated with this access point. For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required. |
| name Required | string The name you want to assign to this access point. |
| publicAccessBlockConfiguration Optional | object The PublicAccessBlock configuration that you want to apply to the access point. |
| publicAccessBlockConfiguration.blockPublicACLs Optional | boolean |
| publicAccessBlockConfiguration.blockPublicPolicy Optional | boolean |
| publicAccessBlockConfiguration.ignorePublicACLs Optional | boolean |
| publicAccessBlockConfiguration.restrictPublicBuckets Optional | boolean |
| vpcConfiguration Optional | object If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC). This is required for creating an access point for Amazon S3 on Outposts buckets. |
| vpcConfiguration.vpcID Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
alias: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| alias Optional | string The name or alias of the access point. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |