AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.s3outposts.Endpoint

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

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[EndpointAccessType] = None,
             customer_owned_ipv4_pool: Optional[str] = None,
             failed_reason: Optional[EndpointFailedReasonArgs] = 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.

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.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const aws_nativeEndpointResource = new aws_native.s3outposts.Endpoint("aws-nativeEndpointResource", {
    outpostId: "string",
    securityGroupId: "string",
    subnetId: "string",
    accessType: aws_native.s3outposts.EndpointAccessType.CustomerOwnedIp,
    customerOwnedIpv4Pool: "string",
    failedReason: {
        errorCode: "string",
        message: "string",
    },
});

Coming soon!

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.
FailedReason Pulumi.AwsNative.S3Outposts.Inputs.EndpointFailedReason: The failure reason, if any, for a create or delete endpoint operation.

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.
FailedReason EndpointFailedReasonArgs: The failure reason, if any, for a create or delete endpoint operation.

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.
failedReason EndpointFailedReason: The failure reason, if any, for a create or delete endpoint operation.

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.
failedReason EndpointFailedReason: The failure reason, if any, for a create or delete endpoint operation.

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.
failed_reason EndpointFailedReasonArgs: The failure reason, if any, for a create or delete endpoint operation.

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.
failedReason Property Map: The failure reason, if any, for a create or delete endpoint operation.

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.
AwsId string: The ID 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.
AwsId string: The ID 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.
awsId String: The ID 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.
awsId string: The ID 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.
aws_id str: The ID 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.
awsId String: The ID 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" | "Create_Failed" | "Delete_Failed"

Supporting Types

EndpointAccessType, EndpointAccessTypeArgs

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

EndpointFailedReason, EndpointFailedReasonArgs

ErrorCode string: The failure code, if any, for a create or delete endpoint operation.
Message string: Additional error details describing the endpoint failure and recommended action.

ErrorCode string: The failure code, if any, for a create or delete endpoint operation.
Message string: Additional error details describing the endpoint failure and recommended action.

errorCode String: The failure code, if any, for a create or delete endpoint operation.
message String: Additional error details describing the endpoint failure and recommended action.

errorCode string: The failure code, if any, for a create or delete endpoint operation.
message string: Additional error details describing the endpoint failure and recommended action.

error_code str: The failure code, if any, for a create or delete endpoint operation.
message str: Additional error details describing the endpoint failure and recommended action.

errorCode String: The failure code, if any, for a create or delete endpoint operation.
message String: Additional error details describing the endpoint failure and recommended action.