1. Packages
  2. AWS Classic
  3. API Docs
  4. s3outposts
  5. Endpoint

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.s3outposts.Endpoint

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a resource to manage an S3 Outposts Endpoint.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.s3outposts.Endpoint("example", {
        outpostId: exampleAwsOutpostsOutpost.id,
        securityGroupId: exampleAwsSecurityGroup.id,
        subnetId: exampleAwsSubnet.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3outposts.Endpoint("example",
        outpost_id=example_aws_outposts_outpost["id"],
        security_group_id=example_aws_security_group["id"],
        subnet_id=example_aws_subnet["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.S3Outposts.Endpoint("example", new()
        {
            OutpostId = exampleAwsOutpostsOutpost.Id,
            SecurityGroupId = exampleAwsSecurityGroup.Id,
            SubnetId = exampleAwsSubnet.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3outposts.Endpoint;
    import com.pulumi.aws.s3outposts.EndpointArgs;
    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) {
            var example = new Endpoint("example", EndpointArgs.builder()
                .outpostId(exampleAwsOutpostsOutpost.id())
                .securityGroupId(exampleAwsSecurityGroup.id())
                .subnetId(exampleAwsSubnet.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:s3outposts:Endpoint
        properties:
          outpostId: ${exampleAwsOutpostsOutpost.id}
          securityGroupId: ${exampleAwsSecurityGroup.id}
          subnetId: ${exampleAwsSubnet.id}
    

    Create Endpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @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,
                 access_type: Optional[str] = None,
                 customer_owned_ipv4_pool: Optional[str] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleendpointResourceResourceFromS3outpostsendpoint = new Aws.S3Outposts.Endpoint("exampleendpointResourceResourceFromS3outpostsendpoint", new()
    {
        OutpostId = "string",
        SecurityGroupId = "string",
        SubnetId = "string",
        AccessType = "string",
        CustomerOwnedIpv4Pool = "string",
    });
    
    example, err := s3outposts.NewEndpoint(ctx, "exampleendpointResourceResourceFromS3outpostsendpoint", &s3outposts.EndpointArgs{
    	OutpostId:             pulumi.String("string"),
    	SecurityGroupId:       pulumi.String("string"),
    	SubnetId:              pulumi.String("string"),
    	AccessType:            pulumi.String("string"),
    	CustomerOwnedIpv4Pool: pulumi.String("string"),
    })
    
    var exampleendpointResourceResourceFromS3outpostsendpoint = new Endpoint("exampleendpointResourceResourceFromS3outpostsendpoint", EndpointArgs.builder()
        .outpostId("string")
        .securityGroupId("string")
        .subnetId("string")
        .accessType("string")
        .customerOwnedIpv4Pool("string")
        .build());
    
    exampleendpoint_resource_resource_from_s3outpostsendpoint = aws.s3outposts.Endpoint("exampleendpointResourceResourceFromS3outpostsendpoint",
        outpost_id="string",
        security_group_id="string",
        subnet_id="string",
        access_type="string",
        customer_owned_ipv4_pool="string")
    
    const exampleendpointResourceResourceFromS3outpostsendpoint = new aws.s3outposts.Endpoint("exampleendpointResourceResourceFromS3outpostsendpoint", {
        outpostId: "string",
        securityGroupId: "string",
        subnetId: "string",
        accessType: "string",
        customerOwnedIpv4Pool: "string",
    });
    
    type: aws:s3outposts:Endpoint
    properties:
        accessType: string
        customerOwnedIpv4Pool: string
        outpostId: string
        securityGroupId: string
        subnetId: string
    

    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.
    AccessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    CustomerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    AccessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    CustomerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    accessType String
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    customerOwnedIpv4Pool String
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    accessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    customerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    access_type str
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    customer_owned_ipv4_pool str
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    accessType String
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    customerOwnedIpv4Pool String
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.

    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 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,
            access_type: Optional[str] = None,
            arn: Optional[str] = None,
            cidr_block: Optional[str] = None,
            creation_time: Optional[str] = None,
            customer_owned_ipv4_pool: 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:
    AccessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    CustomerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    NetworkInterfaces List<EndpointNetworkInterface>
    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.
    AccessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    CustomerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    accessType String
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    customerOwnedIpv4Pool String
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    networkInterfaces List<EndpointNetworkInterface>
    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.
    accessType string
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    customerOwnedIpv4Pool string
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    networkInterfaces EndpointNetworkInterface[]
    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.
    access_type str
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    customer_owned_ipv4_pool str
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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.
    accessType String
    Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
    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.
    customerOwnedIpv4Pool String
    The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
    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, EndpointNetworkInterfaceArgs

    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

    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:

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

    To learn more about importing existing cloud resources, see Importing resources.

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi