Endpoint class

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"])
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3outposts_endpoint" "example" {
  outpost_id        = exampleAwsOutpostsOutpost.id
  security_group_id = exampleAwsSecurityGroup.id
  subnet_id         = 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.ArrayList;
import java.util.Arrays;
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}

Import

Using pulumi import, import S3 Outposts Endpoints using 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

Constructors

Endpoint(String name, {EndpointArgs? args, CustomResourceOptions? options})
Creates a new Endpoint. name The Pulumi resource name. args Arguments used to configure this Endpoint. The set of arguments for Endpoint. options Resource options controlling this resource's behavior.
Endpoint.reference(String urn)
Creates a typed reference to an existing Endpoint resource.

Properties

accessType ↔ Output<String>
Type of access for the network connectivity. Valid values are Private or CustomerOwnedIp.
latefinal
arn ↔ Output<String>
ARN of the endpoint.
latefinal
childResources → Set<Resource>
finalinherited
cidrBlock ↔ Output<String>
VPC CIDR block of the endpoint.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationTime ↔ Output<String>
UTC creation time in RFC3339 format.
latefinal
customerOwnedIpv4Pool ↔ Output<String?>
ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the User Guide.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
networkInterfaces ↔ Output<List<EndpointNetworkInterface>>
Set of nested attributes for associated Elastic Network Interfaces (ENIs).
latefinal
outpostId ↔ Output<String>
Identifier of the Outpost to contain this endpoint.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupId ↔ Output<String>
Identifier of the EC2 Security Group.
latefinal
subnetId ↔ Output<String>
Identifier of the EC2 Subnet.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EndpointState? state, CustomResourceOptions? options}) → Endpoint
Gets an existing Endpoint resource's state with the given name and id.