Try AWS Native preview for resources not in the classic version.
aws.s3outposts.Endpoint
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a resource to manage an S3 Outposts Endpoint.
Example Usage
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 = 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/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(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 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(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 Endpoint Resource
new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_type: Optional[str] = None,
customer_owned_ipv4_pool: Optional[str] = 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:
- Outpost
Id string Identifier of the Outpost to contain this endpoint.
- Security
Group stringId Identifier of the EC2 Security Group.
- Subnet
Id string Identifier of the EC2 Subnet.
- Access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- Customer
Owned stringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- Outpost
Id string Identifier of the Outpost to contain this endpoint.
- Security
Group stringId Identifier of the EC2 Security Group.
- Subnet
Id string Identifier of the EC2 Subnet.
- Access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- Customer
Owned stringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- outpost
Id String Identifier of the Outpost to contain this endpoint.
- security
Group StringId Identifier of the EC2 Security Group.
- subnet
Id String Identifier of the EC2 Subnet.
- access
Type String Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- customer
Owned StringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- outpost
Id string Identifier of the Outpost to contain this endpoint.
- security
Group stringId Identifier of the EC2 Security Group.
- subnet
Id string Identifier of the EC2 Subnet.
- access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- customer
Owned stringIpv4Pool 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_ strid 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
orCustomerOwnedIp
.- customer_
owned_ stripv4_ pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- outpost
Id String Identifier of the Outpost to contain this endpoint.
- security
Group StringId Identifier of the EC2 Security Group.
- subnet
Id String Identifier of the EC2 Subnet.
- access
Type String Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- customer
Owned StringIpv4Pool 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.
- Cidr
Block string VPC CIDR block of the endpoint.
- Creation
Time string UTC creation time in RFC3339 format.
- Id string
The provider-assigned unique ID for this managed resource.
- Network
Interfaces List<EndpointNetwork Interface> Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- Arn string
Amazon Resource Name (ARN) of the endpoint.
- Cidr
Block string VPC CIDR block of the endpoint.
- Creation
Time string UTC creation time in RFC3339 format.
- Id string
The provider-assigned unique ID for this managed resource.
- Network
Interfaces []EndpointNetwork Interface Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- arn String
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block String VPC CIDR block of the endpoint.
- creation
Time String UTC creation time in RFC3339 format.
- id String
The provider-assigned unique ID for this managed resource.
- network
Interfaces List<EndpointNetwork Interface> Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- arn string
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block string VPC CIDR block of the endpoint.
- creation
Time string UTC creation time in RFC3339 format.
- id string
The provider-assigned unique ID for this managed resource.
- network
Interfaces EndpointNetwork Interface[] 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[EndpointNetwork Interface] Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- arn String
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block String VPC CIDR block of the endpoint.
- creation
Time String UTC creation time in RFC3339 format.
- id String
The provider-assigned unique ID for this managed resource.
- network
Interfaces 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.
- Access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- Arn string
Amazon Resource Name (ARN) of the endpoint.
- Cidr
Block string VPC CIDR block of the endpoint.
- Creation
Time string UTC creation time in RFC3339 format.
- Customer
Owned stringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- Network
Interfaces List<EndpointNetwork Interface> Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- Outpost
Id string Identifier of the Outpost to contain this endpoint.
- Security
Group stringId Identifier of the EC2 Security Group.
- Subnet
Id string Identifier of the EC2 Subnet.
- Access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- Arn string
Amazon Resource Name (ARN) of the endpoint.
- Cidr
Block string VPC CIDR block of the endpoint.
- Creation
Time string UTC creation time in RFC3339 format.
- Customer
Owned stringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- Network
Interfaces []EndpointNetwork Interface Args Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- Outpost
Id string Identifier of the Outpost to contain this endpoint.
- Security
Group stringId Identifier of the EC2 Security Group.
- Subnet
Id string Identifier of the EC2 Subnet.
- access
Type String Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- arn String
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block String VPC CIDR block of the endpoint.
- creation
Time String UTC creation time in RFC3339 format.
- customer
Owned StringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- network
Interfaces List<EndpointNetwork Interface> Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- outpost
Id String Identifier of the Outpost to contain this endpoint.
- security
Group StringId Identifier of the EC2 Security Group.
- subnet
Id String Identifier of the EC2 Subnet.
- access
Type string Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- arn string
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block string VPC CIDR block of the endpoint.
- creation
Time string UTC creation time in RFC3339 format.
- customer
Owned stringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- network
Interfaces EndpointNetwork Interface[] Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- outpost
Id string Identifier of the Outpost to contain this endpoint.
- security
Group stringId Identifier of the EC2 Security Group.
- subnet
Id string Identifier of the EC2 Subnet.
- access_
type str Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- 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_ stripv4_ pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- network_
interfaces Sequence[EndpointNetwork Interface Args] Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- outpost_
id str Identifier of the Outpost to contain this endpoint.
- security_
group_ strid Identifier of the EC2 Security Group.
- subnet_
id str Identifier of the EC2 Subnet.
- access
Type String Type of access for the network connectivity. Valid values are
Private
orCustomerOwnedIp
.- arn String
Amazon Resource Name (ARN) of the endpoint.
- cidr
Block String VPC CIDR block of the endpoint.
- creation
Time String UTC creation time in RFC3339 format.
- customer
Owned StringIpv4Pool The ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
- network
Interfaces List<Property Map> Set of nested attributes for associated Elastic Network Interfaces (ENIs).
- outpost
Id String Identifier of the Outpost to contain this endpoint.
- security
Group StringId Identifier of the EC2 Security Group.
- subnet
Id String Identifier of the EC2 Subnet.
Supporting Types
EndpointNetworkInterface, EndpointNetworkInterfaceArgs
- Network
Interface stringId Identifier of the Elastic Network Interface (ENI).
- Network
Interface stringId Identifier of the Elastic Network Interface (ENI).
- network
Interface StringId Identifier of the Elastic Network Interface (ENI).
- network
Interface stringId Identifier of the Elastic Network Interface (ENI).
- network_
interface_ strid Identifier of the Elastic Network Interface (ENI).
- network
Interface StringId 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.