s3outposts

package
v7.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint 

type Endpoint struct {
	pulumi.CustomResourceState

	// Type of access for the network connectivity. Valid values are `Private` or `CustomerOwnedIp`.
	AccessType pulumi.StringOutput `pulumi:"accessType"`
	// Amazon Resource Name (ARN) of the endpoint.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// VPC CIDR block of the endpoint.
	CidrBlock pulumi.StringOutput `pulumi:"cidrBlock"`
	// UTC creation time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).
	CreationTime pulumi.StringOutput `pulumi:"creationTime"`
	// The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the [User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/local-rack.html#local-gateway-subnet).
	CustomerOwnedIpv4Pool pulumi.StringPtrOutput `pulumi:"customerOwnedIpv4Pool"`
	// Set of nested attributes for associated Elastic Network Interfaces (ENIs).
	NetworkInterfaces EndpointNetworkInterfaceArrayOutput `pulumi:"networkInterfaces"`
	// Identifier of the Outpost to contain this endpoint.
	OutpostId pulumi.StringOutput `pulumi:"outpostId"`
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringOutput `pulumi:"region"`
	// Identifier of the EC2 Security Group.
	SecurityGroupId pulumi.StringOutput `pulumi:"securityGroupId"`
	// Identifier of the EC2 Subnet.
	SubnetId pulumi.StringOutput `pulumi:"subnetId"`
}

Provides a resource to manage an S3 Outposts Endpoint.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3outposts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3outposts.NewEndpoint(ctx, "example", &s3outposts.EndpointArgs{
			OutpostId:       pulumi.Any(exampleAwsOutpostsOutpost.Id),
			SecurityGroupId: pulumi.Any(exampleAwsSecurityGroup.Id),
			SubnetId:        pulumi.Any(exampleAwsSubnet.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import S3 Outposts Endpoints using Amazon Resource Name (ARN), EC2 Security Group identifier, and EC2 Subnet identifier, separated by commas (`,`). For example:

```sh $ pulumi import aws:s3outposts/endpoint:Endpoint example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/endpoint/0123456789abcdef,sg-12345678,subnet-12345678 ```

func GetEndpoint 

func GetEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EndpointState, opts ...pulumi.ResourceOption) (*Endpoint, error)

GetEndpoint gets an existing Endpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEndpoint 

func NewEndpoint(ctx *pulumi.Context,
	name string, args *EndpointArgs, opts ...pulumi.ResourceOption) (*Endpoint, error)

NewEndpoint registers a new resource with the given unique name, arguments, and options.

func (*Endpoint) ElementType 

func (*Endpoint) ElementType() reflect.Type

func (*Endpoint) ToEndpointOutput 

func (i *Endpoint) ToEndpointOutput() EndpointOutput

func (*Endpoint) ToEndpointOutputWithContext 

func (i *Endpoint) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointArgs 

type EndpointArgs struct {
	// Type of access for the network connectivity. Valid values are `Private` or `CustomerOwnedIp`.
	AccessType pulumi.StringPtrInput
	// The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the [User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/local-rack.html#local-gateway-subnet).
	CustomerOwnedIpv4Pool pulumi.StringPtrInput
	// Identifier of the Outpost to contain this endpoint.
	OutpostId pulumi.StringInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// Identifier of the EC2 Security Group.
	SecurityGroupId pulumi.StringInput
	// Identifier of the EC2 Subnet.
	SubnetId pulumi.StringInput
}

The set of arguments for constructing a Endpoint resource.

func (EndpointArgs) ElementType 

func (EndpointArgs) ElementType() reflect.Type

type EndpointArray 

type EndpointArray []EndpointInput

func (EndpointArray) ElementType 

func (EndpointArray) ElementType() reflect.Type

func (EndpointArray) ToEndpointArrayOutput 

func (i EndpointArray) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArray) ToEndpointArrayOutputWithContext 

func (i EndpointArray) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointArrayInput 

type EndpointArrayInput interface {
	pulumi.Input

	ToEndpointArrayOutput() EndpointArrayOutput
	ToEndpointArrayOutputWithContext(context.Context) EndpointArrayOutput
}

EndpointArrayInput is an input type that accepts EndpointArray and EndpointArrayOutput values. You can construct a concrete instance of `EndpointArrayInput` via: 

EndpointArray{ EndpointArgs{...} }

type EndpointArrayOutput 

type EndpointArrayOutput struct{ *pulumi.OutputState }

func (EndpointArrayOutput) ElementType 

func (EndpointArrayOutput) ElementType() reflect.Type

func (EndpointArrayOutput) Index 

func (o EndpointArrayOutput) Index(i pulumi.IntInput) EndpointOutput

func (EndpointArrayOutput) ToEndpointArrayOutput 

func (o EndpointArrayOutput) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArrayOutput) ToEndpointArrayOutputWithContext 

func (o EndpointArrayOutput) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointInput 

type EndpointInput interface {
	pulumi.Input

	ToEndpointOutput() EndpointOutput
	ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
}

type EndpointMap 

type EndpointMap map[string]EndpointInput

func (EndpointMap) ElementType 

func (EndpointMap) ElementType() reflect.Type

func (EndpointMap) ToEndpointMapOutput 

func (i EndpointMap) ToEndpointMapOutput() EndpointMapOutput

func (EndpointMap) ToEndpointMapOutputWithContext 

func (i EndpointMap) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput

type EndpointMapInput 

type EndpointMapInput interface {
	pulumi.Input

	ToEndpointMapOutput() EndpointMapOutput
	ToEndpointMapOutputWithContext(context.Context) EndpointMapOutput
}

EndpointMapInput is an input type that accepts EndpointMap and EndpointMapOutput values. You can construct a concrete instance of `EndpointMapInput` via: 

EndpointMap{ "key": EndpointArgs{...} }

type EndpointMapOutput 

type EndpointMapOutput struct{ *pulumi.OutputState }

func (EndpointMapOutput) ElementType 

func (EndpointMapOutput) ElementType() reflect.Type

func (EndpointMapOutput) MapIndex 

func (o EndpointMapOutput) MapIndex(k pulumi.StringInput) EndpointOutput

func (EndpointMapOutput) ToEndpointMapOutput 

func (o EndpointMapOutput) ToEndpointMapOutput() EndpointMapOutput

func (EndpointMapOutput) ToEndpointMapOutputWithContext 

func (o EndpointMapOutput) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput

type EndpointNetworkInterface 

type EndpointNetworkInterface struct {
	// Identifier of the Elastic Network Interface (ENI).
	NetworkInterfaceId *string `pulumi:"networkInterfaceId"`
}

type EndpointNetworkInterfaceArgs 

type EndpointNetworkInterfaceArgs struct {
	// Identifier of the Elastic Network Interface (ENI).
	NetworkInterfaceId pulumi.StringPtrInput `pulumi:"networkInterfaceId"`
}

func (EndpointNetworkInterfaceArgs) ElementType 

func (EndpointNetworkInterfaceArgs) ElementType() reflect.Type

func (EndpointNetworkInterfaceArgs) ToEndpointNetworkInterfaceOutput 

func (i EndpointNetworkInterfaceArgs) ToEndpointNetworkInterfaceOutput() EndpointNetworkInterfaceOutput

func (EndpointNetworkInterfaceArgs) ToEndpointNetworkInterfaceOutputWithContext 

func (i EndpointNetworkInterfaceArgs) ToEndpointNetworkInterfaceOutputWithContext(ctx context.Context) EndpointNetworkInterfaceOutput

type EndpointNetworkInterfaceArray 

type EndpointNetworkInterfaceArray []EndpointNetworkInterfaceInput

func (EndpointNetworkInterfaceArray) ElementType 

func (EndpointNetworkInterfaceArray) ElementType() reflect.Type

func (EndpointNetworkInterfaceArray) ToEndpointNetworkInterfaceArrayOutput 

func (i EndpointNetworkInterfaceArray) ToEndpointNetworkInterfaceArrayOutput() EndpointNetworkInterfaceArrayOutput

func (EndpointNetworkInterfaceArray) ToEndpointNetworkInterfaceArrayOutputWithContext 

func (i EndpointNetworkInterfaceArray) ToEndpointNetworkInterfaceArrayOutputWithContext(ctx context.Context) EndpointNetworkInterfaceArrayOutput

type EndpointNetworkInterfaceArrayInput 

type EndpointNetworkInterfaceArrayInput interface {
	pulumi.Input

	ToEndpointNetworkInterfaceArrayOutput() EndpointNetworkInterfaceArrayOutput
	ToEndpointNetworkInterfaceArrayOutputWithContext(context.Context) EndpointNetworkInterfaceArrayOutput
}

EndpointNetworkInterfaceArrayInput is an input type that accepts EndpointNetworkInterfaceArray and EndpointNetworkInterfaceArrayOutput values. You can construct a concrete instance of `EndpointNetworkInterfaceArrayInput` via: 

EndpointNetworkInterfaceArray{ EndpointNetworkInterfaceArgs{...} }

type EndpointNetworkInterfaceArrayOutput 

type EndpointNetworkInterfaceArrayOutput struct{ *pulumi.OutputState }

func (EndpointNetworkInterfaceArrayOutput) ElementType 

func (EndpointNetworkInterfaceArrayOutput) ElementType() reflect.Type

func (EndpointNetworkInterfaceArrayOutput) Index 

func (o EndpointNetworkInterfaceArrayOutput) Index(i pulumi.IntInput) EndpointNetworkInterfaceOutput

func (EndpointNetworkInterfaceArrayOutput) ToEndpointNetworkInterfaceArrayOutput 

func (o EndpointNetworkInterfaceArrayOutput) ToEndpointNetworkInterfaceArrayOutput() EndpointNetworkInterfaceArrayOutput

func (EndpointNetworkInterfaceArrayOutput) ToEndpointNetworkInterfaceArrayOutputWithContext 

func (o EndpointNetworkInterfaceArrayOutput) ToEndpointNetworkInterfaceArrayOutputWithContext(ctx context.Context) EndpointNetworkInterfaceArrayOutput

type EndpointNetworkInterfaceInput 

type EndpointNetworkInterfaceInput interface {
	pulumi.Input

	ToEndpointNetworkInterfaceOutput() EndpointNetworkInterfaceOutput
	ToEndpointNetworkInterfaceOutputWithContext(context.Context) EndpointNetworkInterfaceOutput
}

EndpointNetworkInterfaceInput is an input type that accepts EndpointNetworkInterfaceArgs and EndpointNetworkInterfaceOutput values. You can construct a concrete instance of `EndpointNetworkInterfaceInput` via: 

EndpointNetworkInterfaceArgs{...}

type EndpointNetworkInterfaceOutput 

type EndpointNetworkInterfaceOutput struct{ *pulumi.OutputState }

func (EndpointNetworkInterfaceOutput) ElementType 

func (EndpointNetworkInterfaceOutput) ElementType() reflect.Type

func (EndpointNetworkInterfaceOutput) NetworkInterfaceId 

func (o EndpointNetworkInterfaceOutput) NetworkInterfaceId() pulumi.StringPtrOutput

Identifier of the Elastic Network Interface (ENI).

func (EndpointNetworkInterfaceOutput) ToEndpointNetworkInterfaceOutput 

func (o EndpointNetworkInterfaceOutput) ToEndpointNetworkInterfaceOutput() EndpointNetworkInterfaceOutput

func (EndpointNetworkInterfaceOutput) ToEndpointNetworkInterfaceOutputWithContext 

func (o EndpointNetworkInterfaceOutput) ToEndpointNetworkInterfaceOutputWithContext(ctx context.Context) EndpointNetworkInterfaceOutput

type EndpointOutput 

type EndpointOutput struct{ *pulumi.OutputState }

func (EndpointOutput) AccessType 

func (o EndpointOutput) AccessType() pulumi.StringOutput

Type of access for the network connectivity. Valid values are `Private` or `CustomerOwnedIp`.

func (EndpointOutput) Arn 

func (o EndpointOutput) Arn() pulumi.StringOutput

Amazon Resource Name (ARN) of the endpoint.

func (EndpointOutput) CidrBlock 

func (o EndpointOutput) CidrBlock() pulumi.StringOutput

VPC CIDR block of the endpoint.

func (EndpointOutput) CreationTime 

func (o EndpointOutput) CreationTime() pulumi.StringOutput

UTC creation time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).

func (EndpointOutput) CustomerOwnedIpv4Pool 

func (o EndpointOutput) CustomerOwnedIpv4Pool() pulumi.StringPtrOutput

The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the [User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/local-rack.html#local-gateway-subnet).

func (EndpointOutput) ElementType 

func (EndpointOutput) ElementType() reflect.Type

func (EndpointOutput) NetworkInterfaces 

func (o EndpointOutput) NetworkInterfaces() EndpointNetworkInterfaceArrayOutput

Set of nested attributes for associated Elastic Network Interfaces (ENIs).

func (EndpointOutput) OutpostId 

func (o EndpointOutput) OutpostId() pulumi.StringOutput

Identifier of the Outpost to contain this endpoint.

func (EndpointOutput) Region 

func (o EndpointOutput) Region() pulumi.StringOutput

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

func (EndpointOutput) SecurityGroupId 

func (o EndpointOutput) SecurityGroupId() pulumi.StringOutput

Identifier of the EC2 Security Group.

func (EndpointOutput) SubnetId 

func (o EndpointOutput) SubnetId() pulumi.StringOutput

Identifier of the EC2 Subnet.

func (EndpointOutput) ToEndpointOutput 

func (o EndpointOutput) ToEndpointOutput() EndpointOutput

func (EndpointOutput) ToEndpointOutputWithContext 

func (o EndpointOutput) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointState 

type EndpointState struct {
	// Type of access for the network connectivity. Valid values are `Private` or `CustomerOwnedIp`.
	AccessType pulumi.StringPtrInput
	// Amazon Resource Name (ARN) of the endpoint.
	Arn pulumi.StringPtrInput
	// VPC CIDR block of the endpoint.
	CidrBlock pulumi.StringPtrInput
	// UTC creation time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).
	CreationTime pulumi.StringPtrInput
	// The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the [User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/local-rack.html#local-gateway-subnet).
	CustomerOwnedIpv4Pool pulumi.StringPtrInput
	// Set of nested attributes for associated Elastic Network Interfaces (ENIs).
	NetworkInterfaces EndpointNetworkInterfaceArrayInput
	// Identifier of the Outpost to contain this endpoint.
	OutpostId pulumi.StringPtrInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// Identifier of the EC2 Security Group.
	SecurityGroupId pulumi.StringPtrInput
	// Identifier of the EC2 Subnet.
	SubnetId pulumi.StringPtrInput
}

func (EndpointState) ElementType 

func (EndpointState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.