Package com.pulumi.aws.odb

Class Network

  • public class Network
extends com.pulumi.resources.CustomResource
    Resource for managing odb Network resource in AWS for Oracle Database@AWS. ## Example Usage ### Disabled S3 and Zero-ETL Access 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.odb.Network;
 import com.pulumi.aws.odb.NetworkArgs;
 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 Network("example", NetworkArgs.builder()
             .displayName("odb-my-net")
             .availabilityZoneId("use1-az6")
             .clientSubnetCidr("10.2.0.0/24")
             .backupSubnetCidr("10.2.1.0/24")
             .s3Access("DISABLED")
             .zeroEtlAccess("DISABLED")
             .tags(Map.of("env", "dev"))
             .build());
 
     }
 }
    ### Enabled S3 and Zero-ETL Access 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.odb.Network;
 import com.pulumi.aws.odb.NetworkArgs;
 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 Network("example", NetworkArgs.builder()
             .displayName("odb-my-net")
             .availabilityZoneId("use1-az6")
             .clientSubnetCidr("10.2.0.0/24")
             .backupSubnetCidr("10.2.1.0/24")
             .s3Access("ENABLED")
             .zeroEtlAccess("ENABLED")
             .tags(Map.of("env", "dev"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Odb Network using the `id`. For example: ```sh $ pulumi import aws:odb/network:Network example example ```

    • 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
      Network​(java.lang.String name)  
      Network​(java.lang.String name, NetworkArgs args)  
      Network​(java.lang.String name, NetworkArgs 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> arn()  
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.lang.String> availabilityZoneId()  
      com.pulumi.core.Output<java.lang.String> backupSubnetCidr()  
      com.pulumi.core.Output<java.lang.String> clientSubnetCidr()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> crossRegionS3RestoreSourcesAccesses()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customDomainName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultDnsPrefix()  
      com.pulumi.core.Output<java.lang.Boolean> deleteAssociatedResources()  
      com.pulumi.core.Output<java.lang.String> displayName()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> ec2PlacementGroupIds()  
      static Network get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, NetworkState 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.lang.String> kmsAccess()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsPolicyDocument()  
      com.pulumi.core.Output<java.util.List<NetworkManagedService>> managedServices()  
      com.pulumi.core.Output<java.util.List<NetworkOciDnsForwardingConfig>> ociDnsForwardingConfigs()  
      com.pulumi.core.Output<java.lang.String> ociNetworkAnchorId()  
      com.pulumi.core.Output<java.lang.String> ociNetworkAnchorUrl()  
      com.pulumi.core.Output<java.lang.String> ociResourceAnchorName()  
      com.pulumi.core.Output<java.lang.String> ociVcnId()  
      com.pulumi.core.Output<java.lang.String> ociVcnUrl()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> peeredCidrs()  
      com.pulumi.core.Output<java.lang.Double> percentProgress()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> s3Access()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> s3PolicyDocument()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.lang.String> statusReason()  
      com.pulumi.core.Output<java.lang.String> stsAccess()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> stsPolicyDocument()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<NetworkTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> zeroEtlAccess()  

      • 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

      • Network

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

      • Network

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

      • Network

        public Network​(java.lang.String name,
               NetworkArgs 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

      • arn

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

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        Name of the Availability Zone (AZ) where the odb network is located. Changing this will force terraform to create new resource. Make sure `availabilityZone` maps correctly with `availabilityZoneId`.

      • availabilityZoneId

        public com.pulumi.core.Output<java.lang.String> availabilityZoneId()
        Returns:
        AZ ID of the AZ where the ODB network is located. Changing this will force terraform to create new resource.

      • backupSubnetCidr

        public com.pulumi.core.Output<java.lang.String> backupSubnetCidr()
        Returns:
        CIDR range of the backup subnet for the ODB network. Changing this will force terraform to create new resource.

      • clientSubnetCidr

        public com.pulumi.core.Output<java.lang.String> clientSubnetCidr()
        Returns:
        CIDR notation for the network resource. Changing this will force terraform to create new resource.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Date and time when the ODB network was created.

      • crossRegionS3RestoreSourcesAccesses

        public com.pulumi.core.Output<java.util.List<java.lang.String>> crossRegionS3RestoreSourcesAccesses()
        Returns:
        List of regions enabled for cross-region restore in the ODB network.

      • customDomainName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customDomainName()
        Returns:
        Name of the custom domain that the network is located. `customDomainName` and `defaultDnsPrefix` both can't be given. Changing this will force terraform to create new resource.

      • defaultDnsPrefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultDnsPrefix()
        Returns:
        Default DNS prefix for the network resource. Changing this will force terraform to create new resource.

      • deleteAssociatedResources

        public com.pulumi.core.Output<java.lang.Boolean> deleteAssociatedResources()
        Returns:
        If set to true deletes associated OCI resources. Default false.

      • displayName

        public com.pulumi.core.Output<java.lang.String> displayName()
        Returns:
        User-friendly name for the odb network. Changing this will force terraform to create a new resource.

      • ec2PlacementGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> ec2PlacementGroupIds()
        Returns:
        List of EC2 placement group IDs associated with the ODB network.

      • kmsAccess

        public com.pulumi.core.Output<java.lang.String> kmsAccess()
        Returns:
        Configuration for KMS access from the ODB network.

      • kmsPolicyDocument

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsPolicyDocument()
        Returns:
        Endpoint policy for KMS access from the ODB network.

      • managedServices

        public com.pulumi.core.Output<java.util.List<NetworkManagedService>> managedServices()
        Returns:
        Managed services configuration for the ODB network. See `managedServices` Block below.

      • ociDnsForwardingConfigs

        public com.pulumi.core.Output<java.util.List<NetworkOciDnsForwardingConfig>> ociDnsForwardingConfigs()
        Returns:
        DNS resolver endpoints in OCI for forwarding DNS queries for the `ociPrivateZone` domain. See `ociDnsForwardingConfigs` Block below.

      • ociNetworkAnchorId

        public com.pulumi.core.Output<java.lang.String> ociNetworkAnchorId()
        Returns:
        Unique identifier of the OCI network anchor for the ODB network.

      • ociNetworkAnchorUrl

        public com.pulumi.core.Output<java.lang.String> ociNetworkAnchorUrl()
        Returns:
        URL of the OCI network anchor for the ODB network.

      • ociResourceAnchorName

        public com.pulumi.core.Output<java.lang.String> ociResourceAnchorName()
        Returns:
        Name of the OCI resource anchor for the ODB network.

      • ociVcnId

        public com.pulumi.core.Output<java.lang.String> ociVcnId()
        Returns:
        Unique identifier Oracle Cloud ID (OCID) of the OCI VCN for the ODB network.

      • ociVcnUrl

        public com.pulumi.core.Output<java.lang.String> ociVcnUrl()
        Returns:
        URL of the OCI VCN for the ODB network.

      • peeredCidrs

        public com.pulumi.core.Output<java.util.List<java.lang.String>> peeredCidrs()
        Returns:
        List of CIDR ranges from the peered VPC that are allowed access to the ODB network. See the [ODB network peering documentation](https://docs.aws.amazon.com/odb/latest/UserGuide/network-peering.html) for more information.

      • percentProgress

        public com.pulumi.core.Output<java.lang.Double> percentProgress()
        Returns:
        Amount of progress made on the current operation on the ODB network, expressed as a percentage.

      • 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.

      • s3Access

        public com.pulumi.core.Output<java.lang.String> s3Access()
        Returns:
        Configuration for Amazon S3 access from the ODB network.

      • s3PolicyDocument

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> s3PolicyDocument()
        Returns:
        Endpoint policy for Amazon S3 access from the ODB network.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the Zero-ETL access.

      • statusReason

        public com.pulumi.core.Output<java.lang.String> statusReason()
        Returns:
        Additional information about the current status of the ODB network.

      • stsAccess

        public com.pulumi.core.Output<java.lang.String> stsAccess()
        Returns:
        Configuration for STS access from the ODB network.

      • stsPolicyDocument

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> stsPolicyDocument()
        Returns:
        Endpoint policy for STS access from the ODB network.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the exadata infrastructure. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<NetworkTimeouts>> timeouts()

      • zeroEtlAccess

        public com.pulumi.core.Output<java.lang.String> zeroEtlAccess()
        Returns:
        Configuration for Zero-ETL access from the ODB network. The following arguments are optional:

      • get

        public static Network get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          NetworkState 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.