NetworkPeeringConnection class
Terraform resource for managing oracle database network peering resource in AWS. If underlying odb network is shared, ARN must be used while creating network peering.
You can find out more about Oracle Database@AWS from User Guide.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.odb.NetworkPeeringConnection("example", {
displayName: "example",
odbNetworkId: "my-odb-network-id",
peerNetworkId: "my-vpc-id",
tags: {
env: "dev",
},
});
import pulumi
import pulumi_aws as aws
example = aws.odb.NetworkPeeringConnection("example",
display_name="example",
odb_network_id="my-odb-network-id",
peer_network_id="my-vpc-id",
tags={
"env": "dev",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Odb.NetworkPeeringConnection("example", new()
{
DisplayName = "example",
OdbNetworkId = "my-odb-network-id",
PeerNetworkId = "my-vpc-id",
Tags =
{
{ "env", "dev" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/odb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := odb.NewNetworkPeeringConnection(ctx, "example", &odb.NetworkPeeringConnectionArgs{
DisplayName: pulumi.String("example"),
OdbNetworkId: pulumi.String("my-odb-network-id"),
PeerNetworkId: pulumi.String("my-vpc-id"),
Tags: pulumi.StringMap{
"env": pulumi.String("dev"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_odb_networkpeeringconnection" "example" {
display_name = "example"
odb_network_id = "my-odb-network-id"
peer_network_id = "my-vpc-id"
tags = {
"env" = "dev"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.odb.NetworkPeeringConnection;
import com.pulumi.aws.odb.NetworkPeeringConnectionArgs;
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 NetworkPeeringConnection("example", NetworkPeeringConnectionArgs.builder()
.displayName("example")
.odbNetworkId("my-odb-network-id")
.peerNetworkId("my-vpc-id")
.tags(Map.of("env", "dev"))
.build());
}
}
resources:
example:
type: aws:odb:NetworkPeeringConnection
properties:
displayName: example
odbNetworkId: my-odb-network-id
peerNetworkId: my-vpc-id
tags:
env: dev
Import
Using pulumi import, import odb network peering using the id. For example:
$ pulumi import aws:odb/networkPeeringConnection:NetworkPeeringConnection example example
Constructors
- NetworkPeeringConnection(String name, {NetworkPeeringConnectionArgs? args, CustomResourceOptions? options})
-
Creates a new NetworkPeeringConnection.
nameThe Pulumi resource name.argsArguments used to configure this NetworkPeeringConnection. The set of arguments for NetworkPeeringConnection.optionsResource options controlling this resource's behavior. - NetworkPeeringConnection.reference(String urn)
- Creates a typed reference to an existing NetworkPeeringConnection resource.
Properties
-
arn
↔ Output<
String> -
ARN of the ODB network peering connection.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdAt
↔ Output<
String> -
Created time of the ODB network peering connection.
latefinal
-
displayName
↔ Output<
String> -
Display name of the ODB network peering connection. Changing this will force Terraform to create a new resource.
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
-
odbNetworkArn
↔ Output<
String> -
ARN of the ODB network that initiates the peering connection. Changing this will force Terraform to create a new resource. Either odbNetworkId or odbNetworkArn should be used.
latefinal
-
odbNetworkId
↔ Output<
String> -
Unique identifier of the ODB network that initiates the peering connection. A sample ID is
odbpcx-abcdefgh12345678. Changing this will force Terraform to create a new resource.latefinal -
odbPeeringConnectionType
↔ Output<
String> -
Type of the ODB peering connection.
latefinal
-
peerNetworkArn
↔ Output<
String> -
ARN of the peer network peering connection.
latefinal
-
peerNetworkCidrs
↔ Output<
List< String> > -
Set of peer network cidrs. Add remove is only supported during update operation. During create this attribute is compute only.
latefinal
-
peerNetworkId
↔ Output<
String> -
Unique identifier of the ODB peering connection. Changing this will force Terraform to create a new resource. Either odbNetworkId or odbNetworkArn should be used.
latefinal
-
percentProgress
↔ Output<
double> -
Progress of the ODB network peering connection.
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
-
status
↔ Output<
String> -
Status of the ODB network peering connection.
latefinal
-
statusReason
↔ Output<
String> -
Reason for the current status of the ODB peering connection.
latefinal
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including inherited tags.
latefinal
-
timeouts
↔ Output<
NetworkPeeringConnectionTimeouts?> -
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, {NetworkPeeringConnectionState? state, CustomResourceOptions? options}) → NetworkPeeringConnection -
Gets an existing NetworkPeeringConnection resource's state with the given
nameandid.