Package com.pulumi.aws.s3outposts

Class Endpoint

  • public class Endpoint
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an S3 Outposts Endpoint. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import S3 Outposts Endpoints using ARN, EC2 Security Group identifier, and EC2 Subnet identifier, separated by commas (`,`). For example: ```sh $ pulumi import aws:s3outposts/endpoint:Endpoint example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/endpoint/0123456789abcdef,sg-12345678,subnet-12345678 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Endpoint​(java.lang.String name)  
      Endpoint​(java.lang.String name, EndpointArgs args)  
      Endpoint​(java.lang.String name, EndpointArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> accessType()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> cidrBlock()  
      com.pulumi.core.Output<java.lang.String> creationTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerOwnedIpv4Pool()  
      static Endpoint get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EndpointState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<EndpointNetworkInterface>> networkInterfaces()  
      com.pulumi.core.Output<java.lang.String> outpostId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> securityGroupId()  
      com.pulumi.core.Output<java.lang.String> subnetId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Endpoint

        public Endpoint​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Endpoint

        public Endpoint​(java.lang.String name,
                EndpointArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Endpoint

        public Endpoint​(java.lang.String name,
                EndpointArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accessType

        public com.pulumi.core.Output<java.lang.String> accessType()
        Returns:
        Type of access for the network connectivity. Valid values are `Private` or `CustomerOwnedIp`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the endpoint.

      • cidrBlock

        public com.pulumi.core.Output<java.lang.String> cidrBlock()
        Returns:
        VPC CIDR block of the endpoint.

      • creationTime

        public com.pulumi.core.Output<java.lang.String> creationTime()
        Returns:
        UTC creation time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).

      • customerOwnedIpv4Pool

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerOwnedIpv4Pool()
        Returns:
        ID of a Customer Owned IP Pool. For more on customer owned IP addresses see the [User Guide](https://docs.aws.amazon.com/outposts/latest/userguide/local-rack.html#local-gateway-subnet).

      • networkInterfaces

        public com.pulumi.core.Output<java.util.List<EndpointNetworkInterface>> networkInterfaces()
        Returns:
        Set of nested attributes for associated Elastic Network Interfaces (ENIs).

      • outpostId

        public com.pulumi.core.Output<java.lang.String> outpostId()
        Returns:
        Identifier of the Outpost to contain this endpoint.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • securityGroupId

        public com.pulumi.core.Output<java.lang.String> securityGroupId()
        Returns:
        Identifier of the EC2 Security Group.

      • subnetId

        public com.pulumi.core.Output<java.lang.String> subnetId()
        Returns:
        Identifier of the EC2 Subnet.

      • get

        public static Endpoint get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           EndpointState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.