AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Endpoint

Provides a resource to manage an S3 Outposts Endpoint.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.S3Outposts.Endpoint("example", new Aws.S3Outposts.EndpointArgs
        {
            OutpostId = data.Aws_outposts_outpost.Example.Id,
            SecurityGroupId = aws_security_group.Example.Id,
            SubnetId = aws_subnet.Example.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(data.Aws_outposts_outpost.Example.Id),
			SecurityGroupId: pulumi.Any(aws_security_group.Example.Id),
			SubnetId:        pulumi.Any(aws_subnet.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Endpoint("example", EndpointArgs.builder()        
            .outpostId(data.aws_outposts_outpost().example().id())
            .securityGroupId(aws_security_group.example().id())
            .subnetId(aws_subnet.example().id())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.s3outposts.Endpoint("example",
    outpost_id=data["aws_outposts_outpost"]["example"]["id"],
    security_group_id=aws_security_group["example"]["id"],
    subnet_id=aws_subnet["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3outposts.Endpoint("example", {
    outpostId: data.aws_outposts_outpost.example.id,
    securityGroupId: aws_security_group.example.id,
    subnetId: aws_subnet.example.id,
});
resources:
  example:
    type: aws:s3outposts:Endpoint
    properties:
      outpostId: ${data.aws_outposts_outpost.example.id}
      securityGroupId: ${aws_security_group.example.id}
      subnetId: ${aws_subnet.example.id}

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             outpost_id: Optional[str] = None,
             security_group_id: Optional[str] = None,
             subnet_id: Optional[str] = None)
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)
func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
type: aws:s3outposts:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Endpoint resource accepts the following input properties:

OutpostId string

Identifier of the Outpost to contain this endpoint.

SecurityGroupId string

Identifier of the EC2 Security Group.

SubnetId string

Identifier of the EC2 Subnet.

OutpostId string

Identifier of the Outpost to contain this endpoint.

SecurityGroupId string

Identifier of the EC2 Security Group.

SubnetId string

Identifier of the EC2 Subnet.

outpostId String

Identifier of the Outpost to contain this endpoint.

securityGroupId String

Identifier of the EC2 Security Group.

subnetId String

Identifier of the EC2 Subnet.

outpostId string

Identifier of the Outpost to contain this endpoint.

securityGroupId string

Identifier of the EC2 Security Group.

subnetId string

Identifier of the EC2 Subnet.

outpost_id str

Identifier of the Outpost to contain this endpoint.

security_group_id str

Identifier of the EC2 Security Group.

subnet_id str

Identifier of the EC2 Subnet.

outpostId String

Identifier of the Outpost to contain this endpoint.

securityGroupId String

Identifier of the EC2 Security Group.

subnetId String

Identifier of the EC2 Subnet.

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

VPC CIDR block of the endpoint.

CreationTime string

UTC creation time in RFC3339 format.

Id string

The provider-assigned unique ID for this managed resource.

NetworkInterfaces List<EndpointNetworkInterface>

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

Arn string

Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

VPC CIDR block of the endpoint.

CreationTime string

UTC creation time in RFC3339 format.

Id string

The provider-assigned unique ID for this managed resource.

NetworkInterfaces []EndpointNetworkInterface

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

arn String

Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

VPC CIDR block of the endpoint.

creationTime String

UTC creation time in RFC3339 format.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaces List<EndpointNetworkInterface>

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

arn string

Amazon Resource Name (ARN) of the endpoint.

cidrBlock string

VPC CIDR block of the endpoint.

creationTime string

UTC creation time in RFC3339 format.

id string

The provider-assigned unique ID for this managed resource.

networkInterfaces EndpointNetworkInterface[]

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

arn str

Amazon Resource Name (ARN) of the endpoint.

cidr_block str

VPC CIDR block of the endpoint.

creation_time str

UTC creation time in RFC3339 format.

id str

The provider-assigned unique ID for this managed resource.

network_interfaces Sequence[EndpointNetworkInterface]

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

arn String

Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

VPC CIDR block of the endpoint.

creationTime String

UTC creation time in RFC3339 format.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaces List<Property Map>

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

Look up an Existing Endpoint Resource

Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cidr_block: Optional[str] = None,
        creation_time: Optional[str] = None,
        network_interfaces: Optional[Sequence[EndpointNetworkInterfaceArgs]] = None,
        outpost_id: Optional[str] = None,
        security_group_id: Optional[str] = None,
        subnet_id: Optional[str] = None) -> Endpoint
func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string

Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

VPC CIDR block of the endpoint.

CreationTime string

UTC creation time in RFC3339 format.

NetworkInterfaces List<EndpointNetworkInterfaceArgs>

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

OutpostId string

Identifier of the Outpost to contain this endpoint.

SecurityGroupId string

Identifier of the EC2 Security Group.

SubnetId string

Identifier of the EC2 Subnet.

Arn string

Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

VPC CIDR block of the endpoint.

CreationTime string

UTC creation time in RFC3339 format.

NetworkInterfaces []EndpointNetworkInterfaceArgs

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

OutpostId string

Identifier of the Outpost to contain this endpoint.

SecurityGroupId string

Identifier of the EC2 Security Group.

SubnetId string

Identifier of the EC2 Subnet.

arn String

Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

VPC CIDR block of the endpoint.

creationTime String

UTC creation time in RFC3339 format.

networkInterfaces List<EndpointNetworkInterfaceArgs>

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

outpostId String

Identifier of the Outpost to contain this endpoint.

securityGroupId String

Identifier of the EC2 Security Group.

subnetId String

Identifier of the EC2 Subnet.

arn string

Amazon Resource Name (ARN) of the endpoint.

cidrBlock string

VPC CIDR block of the endpoint.

creationTime string

UTC creation time in RFC3339 format.

networkInterfaces EndpointNetworkInterfaceArgs[]

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

outpostId string

Identifier of the Outpost to contain this endpoint.

securityGroupId string

Identifier of the EC2 Security Group.

subnetId string

Identifier of the EC2 Subnet.

arn str

Amazon Resource Name (ARN) of the endpoint.

cidr_block str

VPC CIDR block of the endpoint.

creation_time str

UTC creation time in RFC3339 format.

network_interfaces Sequence[EndpointNetworkInterfaceArgs]

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

outpost_id str

Identifier of the Outpost to contain this endpoint.

security_group_id str

Identifier of the EC2 Security Group.

subnet_id str

Identifier of the EC2 Subnet.

arn String

Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

VPC CIDR block of the endpoint.

creationTime String

UTC creation time in RFC3339 format.

networkInterfaces List<Property Map>

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

outpostId String

Identifier of the Outpost to contain this endpoint.

securityGroupId String

Identifier of the EC2 Security Group.

subnetId String

Identifier of the EC2 Subnet.

Supporting Types

EndpointNetworkInterface

NetworkInterfaceId string

Identifier of the Elastic Network Interface (ENI).

NetworkInterfaceId string

Identifier of the Elastic Network Interface (ENI).

networkInterfaceId String

Identifier of the Elastic Network Interface (ENI).

networkInterfaceId string

Identifier of the Elastic Network Interface (ENI).

network_interface_id str

Identifier of the Elastic Network Interface (ENI).

networkInterfaceId String

Identifier of the Elastic Network Interface (ENI).

Import

S3 Outposts Endpoints can be imported using Amazon Resource Name (ARN), EC2 Security Group identifier, and EC2 Subnet identifier, separated by commas (,) e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.