Endpoint

Resource Type Definition for AWS::S3Outposts::Endpoint

Create Endpoint Resource

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

The id of the customer outpost on which the bucket resides.

SecurityGroupId string

The ID of the security group to use with the endpoint.

SubnetId string

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

AccessType Pulumi.AwsNative.S3Outposts.EndpointAccessType

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

CustomerOwnedIpv4Pool string

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

OutpostId string

The id of the customer outpost on which the bucket resides.

SecurityGroupId string

The ID of the security group to use with the endpoint.

SubnetId string

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

AccessType EndpointAccessType

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

CustomerOwnedIpv4Pool string

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

outpostId String

The id of the customer outpost on which the bucket resides.

securityGroupId String

The ID of the security group to use with the endpoint.

subnetId String

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

accessType EndpointAccessType

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

customerOwnedIpv4Pool String

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

outpostId string

The id of the customer outpost on which the bucket resides.

securityGroupId string

The ID of the security group to use with the endpoint.

subnetId string

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

accessType EndpointAccessType

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

customerOwnedIpv4Pool string

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

outpost_id str

The id of the customer outpost on which the bucket resides.

security_group_id str

The ID of the security group to use with the endpoint.

subnet_id str

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

access_type EndpointAccessType

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

customer_owned_ipv4_pool str

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

outpostId String

The id of the customer outpost on which the bucket resides.

securityGroupId String

The ID of the security group to use with the endpoint.

subnetId String

The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.

accessType "CustomerOwnedIp" | "Private"

The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.

customerOwnedIpv4Pool String

The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.

Outputs

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

Arn string

The Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

The VPC CIDR committed by this endpoint.

CreationTime string

The time the endpoint was created.

Id string

The provider-assigned unique ID for this managed resource.

NetworkInterfaces List<Pulumi.AwsNative.S3Outposts.Outputs.EndpointNetworkInterface>

The network interfaces of the endpoint.

Status Pulumi.AwsNative.S3Outposts.EndpointStatus
Arn string

The Amazon Resource Name (ARN) of the endpoint.

CidrBlock string

The VPC CIDR committed by this endpoint.

CreationTime string

The time the endpoint was created.

Id string

The provider-assigned unique ID for this managed resource.

NetworkInterfaces []EndpointNetworkInterface

The network interfaces of the endpoint.

Status EndpointStatus
arn String

The Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

The VPC CIDR committed by this endpoint.

creationTime String

The time the endpoint was created.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaces List<EndpointNetworkInterface>

The network interfaces of the endpoint.

status EndpointStatus
arn string

The Amazon Resource Name (ARN) of the endpoint.

cidrBlock string

The VPC CIDR committed by this endpoint.

creationTime string

The time the endpoint was created.

id string

The provider-assigned unique ID for this managed resource.

networkInterfaces EndpointNetworkInterface[]

The network interfaces of the endpoint.

status EndpointStatus
arn str

The Amazon Resource Name (ARN) of the endpoint.

cidr_block str

The VPC CIDR committed by this endpoint.

creation_time str

The time the endpoint was created.

id str

The provider-assigned unique ID for this managed resource.

network_interfaces Sequence[EndpointNetworkInterface]

The network interfaces of the endpoint.

status EndpointStatus
arn String

The Amazon Resource Name (ARN) of the endpoint.

cidrBlock String

The VPC CIDR committed by this endpoint.

creationTime String

The time the endpoint was created.

id String

The provider-assigned unique ID for this managed resource.

networkInterfaces List<Property Map>

The network interfaces of the endpoint.

status "Available" | "Pending" | "Deleting"

Supporting Types

EndpointAccessType

CustomerOwnedIp
CustomerOwnedIp
Private
Private
EndpointAccessTypeCustomerOwnedIp
CustomerOwnedIp
EndpointAccessTypePrivate
Private
CustomerOwnedIp
CustomerOwnedIp
Private
Private
CustomerOwnedIp
CustomerOwnedIp
Private
Private
CUSTOMER_OWNED_IP
CustomerOwnedIp
PRIVATE
Private
"CustomerOwnedIp"
CustomerOwnedIp
"Private"
Private

EndpointNetworkInterface

EndpointStatus

Available
Available
Pending
Pending
Deleting
Deleting
EndpointStatusAvailable
Available
EndpointStatusPending
Pending
EndpointStatusDeleting
Deleting
Available
Available
Pending
Pending
Deleting
Deleting
Available
Available
Pending
Pending
Deleting
Deleting
AVAILABLE
Available
PENDING
Pending
DELETING
Deleting
"Available"
Available
"Pending"
Pending
"Deleting"
Deleting

Package Details

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