1. Packages
  2. AWS
  3. API Docs
  4. s3control
  5. getMultiRegionAccessPoint
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.s3control.getMultiRegionAccessPoint

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Provides details on a specific S3 Multi-Region Access Point.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.s3control.getMultiRegionAccessPoint({
        name: "example",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3control.get_multi_region_access_point(name="example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3control"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := s3control.LookupMultiRegionAccessPoint(ctx, &s3control.LookupMultiRegionAccessPointArgs{
    			Name: "example",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.S3Control.GetMultiRegionAccessPoint.Invoke(new()
        {
            Name = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3control.S3controlFunctions;
    import com.pulumi.aws.s3control.inputs.GetMultiRegionAccessPointArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = S3controlFunctions.getMultiRegionAccessPoint(GetMultiRegionAccessPointArgs.builder()
                .name("example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:s3control:getMultiRegionAccessPoint
          Arguments:
            name: example
    

    Using getMultiRegionAccessPoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMultiRegionAccessPoint(args: GetMultiRegionAccessPointArgs, opts?: InvokeOptions): Promise<GetMultiRegionAccessPointResult>
    function getMultiRegionAccessPointOutput(args: GetMultiRegionAccessPointOutputArgs, opts?: InvokeOptions): Output<GetMultiRegionAccessPointResult>
    def get_multi_region_access_point(account_id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetMultiRegionAccessPointResult
    def get_multi_region_access_point_output(account_id: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetMultiRegionAccessPointResult]
    func LookupMultiRegionAccessPoint(ctx *Context, args *LookupMultiRegionAccessPointArgs, opts ...InvokeOption) (*LookupMultiRegionAccessPointResult, error)
    func LookupMultiRegionAccessPointOutput(ctx *Context, args *LookupMultiRegionAccessPointOutputArgs, opts ...InvokeOption) LookupMultiRegionAccessPointResultOutput

    > Note: This function is named LookupMultiRegionAccessPoint in the Go SDK.

    public static class GetMultiRegionAccessPoint 
    {
        public static Task<GetMultiRegionAccessPointResult> InvokeAsync(GetMultiRegionAccessPointArgs args, InvokeOptions? opts = null)
        public static Output<GetMultiRegionAccessPointResult> Invoke(GetMultiRegionAccessPointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMultiRegionAccessPointResult> getMultiRegionAccessPoint(GetMultiRegionAccessPointArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:s3control/getMultiRegionAccessPoint:getMultiRegionAccessPoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Multi-Region Access Point.
    AccountId string
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    Name string
    The name of the Multi-Region Access Point.
    AccountId string
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    name String
    The name of the Multi-Region Access Point.
    accountId String
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    name string
    The name of the Multi-Region Access Point.
    accountId string
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    name str
    The name of the Multi-Region Access Point.
    account_id str
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    name String
    The name of the Multi-Region Access Point.
    accountId String
    The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.

    getMultiRegionAccessPoint Result

    The following output properties are available:

    AccountId string
    Alias string
    The alias for the Multi-Region Access Point.
    Arn string
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    CreatedAt string
    Timestamp when the resource has been created.
    DomainName string
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    PublicAccessBlocks List<GetMultiRegionAccessPointPublicAccessBlock>
    Public Access Block of the Multi-Region Access Point. Detailed below.
    Regions List<GetMultiRegionAccessPointRegion>
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    Status string
    The current status of the Multi-Region Access Point.
    AccountId string
    Alias string
    The alias for the Multi-Region Access Point.
    Arn string
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    CreatedAt string
    Timestamp when the resource has been created.
    DomainName string
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    PublicAccessBlocks []GetMultiRegionAccessPointPublicAccessBlock
    Public Access Block of the Multi-Region Access Point. Detailed below.
    Regions []GetMultiRegionAccessPointRegion
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    Status string
    The current status of the Multi-Region Access Point.
    accountId String
    alias String
    The alias for the Multi-Region Access Point.
    arn String
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    createdAt String
    Timestamp when the resource has been created.
    domainName String
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    publicAccessBlocks List<GetMultiRegionAccessPointPublicAccessBlock>
    Public Access Block of the Multi-Region Access Point. Detailed below.
    regions List<GetMultiRegionAccessPointRegion>
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    status String
    The current status of the Multi-Region Access Point.
    accountId string
    alias string
    The alias for the Multi-Region Access Point.
    arn string
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    createdAt string
    Timestamp when the resource has been created.
    domainName string
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    publicAccessBlocks GetMultiRegionAccessPointPublicAccessBlock[]
    Public Access Block of the Multi-Region Access Point. Detailed below.
    regions GetMultiRegionAccessPointRegion[]
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    status string
    The current status of the Multi-Region Access Point.
    account_id str
    alias str
    The alias for the Multi-Region Access Point.
    arn str
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    created_at str
    Timestamp when the resource has been created.
    domain_name str
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    public_access_blocks Sequence[GetMultiRegionAccessPointPublicAccessBlock]
    Public Access Block of the Multi-Region Access Point. Detailed below.
    regions Sequence[GetMultiRegionAccessPointRegion]
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    status str
    The current status of the Multi-Region Access Point.
    accountId String
    alias String
    The alias for the Multi-Region Access Point.
    arn String
    Amazon Resource Name (ARN) of the Multi-Region Access Point.
    createdAt String
    Timestamp when the resource has been created.
    domainName String
    The DNS domain name of the S3 Multi-Region Access Point in the format alias.accesspoint.s3-global.amazonaws.com. For more information, see the documentation on Multi-Region Access Point Requests.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    publicAccessBlocks List<Property Map>
    Public Access Block of the Multi-Region Access Point. Detailed below.
    regions List<Property Map>
    A collection of the regions and buckets associated with the Multi-Region Access Point.
    status String
    The current status of the Multi-Region Access Point.

    Supporting Types

    GetMultiRegionAccessPointPublicAccessBlock

    BlockPublicAcls bool
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    BlockPublicPolicy bool
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    IgnorePublicAcls bool
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    RestrictPublicBuckets bool
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.
    BlockPublicAcls bool
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    BlockPublicPolicy bool
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    IgnorePublicAcls bool
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    RestrictPublicBuckets bool
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.
    blockPublicAcls Boolean
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    blockPublicPolicy Boolean
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    ignorePublicAcls Boolean
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    restrictPublicBuckets Boolean
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.
    blockPublicAcls boolean
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    blockPublicPolicy boolean
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    ignorePublicAcls boolean
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    restrictPublicBuckets boolean
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.
    block_public_acls bool
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    block_public_policy bool
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    ignore_public_acls bool
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    restrict_public_buckets bool
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.
    blockPublicAcls Boolean
    Specifies whether Amazon S3 should block public access control lists (ACLs). When set to true causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
    • PUT Object calls fail if the request includes a public ACL.
    • PUT Bucket calls fail if the request includes a public ACL.
    blockPublicPolicy Boolean
    Specifies whether Amazon S3 should block public bucket policies for buckets in this account. When set to true causes Amazon S3 to:

    • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
    ignorePublicAcls Boolean
    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. When set to true causes Amazon S3 to:

    • Ignore all public ACLs on buckets in this account and any objects that they contain.
    restrictPublicBuckets Boolean
    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. When set to true:

    • Only the bucket owner and AWS Services can access buckets with public policies.

    GetMultiRegionAccessPointRegion

    Bucket string
    The name of the bucket.
    BucketAccountId string
    The AWS account ID that owns the bucket.
    Region string
    The name of the region.
    Bucket string
    The name of the bucket.
    BucketAccountId string
    The AWS account ID that owns the bucket.
    Region string
    The name of the region.
    bucket String
    The name of the bucket.
    bucketAccountId String
    The AWS account ID that owns the bucket.
    region String
    The name of the region.
    bucket string
    The name of the bucket.
    bucketAccountId string
    The AWS account ID that owns the bucket.
    region string
    The name of the region.
    bucket str
    The name of the bucket.
    bucket_account_id str
    The AWS account ID that owns the bucket.
    region str
    The name of the region.
    bucket String
    The name of the bucket.
    bucketAccountId String
    The AWS account ID that owns the bucket.
    region String
    The name of the region.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi