Endpoint class

Cloud IDS is an intrusion detection service that provides threat detection for intrusions, malware, spyware, and command-and-control attacks on your network.

To get more information about Endpoint, see:

API documentation

Example Usage

Cloudids Endpoint

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.Network("default", {name: "tf-test-my-network"});
const serviceRange = new gcp.compute.GlobalAddress("service_range", {
    name: "address",
    purpose: "VPC_PEERING",
    addressType: "INTERNAL",
    prefixLength: 16,
    network: _default.id,
});
const privateServiceConnection = new gcp.servicenetworking.Connection("private_service_connection", {
    network: _default.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [serviceRange.name],
});
const example_endpoint = new gcp.cloudids.Endpoint("example-endpoint", {
    name: "test",
    location: "us-central1-f",
    network: _default.id,
    severity: "INFORMATIONAL",
}, {
    dependsOn: [privateServiceConnection],
});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.Network("default", name="tf-test-my-network")
service_range = gcp.compute.GlobalAddress("service_range",
    name="address",
    purpose="VPC_PEERING",
    address_type="INTERNAL",
    prefix_length=16,
    network=default.id)
private_service_connection = gcp.servicenetworking.Connection("private_service_connection",
    network=default.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[service_range.name])
example_endpoint = gcp.cloudids.Endpoint("example-endpoint",
    name="test",
    location="us-central1-f",
    network=default.id,
    severity="INFORMATIONAL",
    opts = pulumi.ResourceOptions(depends_on=[private_service_connection]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Compute.Network("default", new()
    {
        Name = "tf-test-my-network",
    });

    var serviceRange = new Gcp.Compute.GlobalAddress("service_range", new()
    {
        Name = "address",
        Purpose = "VPC_PEERING",
        AddressType = "INTERNAL",
        PrefixLength = 16,
        Network = @default.Id,
    });

    var privateServiceConnection = new Gcp.ServiceNetworking.Connection("private_service_connection", new()
    {
        Network = @default.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            serviceRange.Name,
        },
    });

    var example_endpoint = new Gcp.CloudIds.Endpoint("example-endpoint", new()
    {
        Name = "test",
        Location = "us-central1-f",
        Network = @default.Id,
        Severity = "INFORMATIONAL",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            privateServiceConnection,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/cloudids"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("tf-test-my-network"),
		})
		if err != nil {
			return err
		}
		serviceRange, err := compute.NewGlobalAddress(ctx, "service_range", &compute.GlobalAddressArgs{
			Name:         pulumi.String("address"),
			Purpose:      pulumi.String("VPC_PEERING"),
			AddressType:  pulumi.String("INTERNAL"),
			PrefixLength: pulumi.Int(16),
			Network:      _default.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		privateServiceConnection, err := servicenetworking.NewConnection(ctx, "private_service_connection", &servicenetworking.ConnectionArgs{
			Network: _default.ID().ToIDOutput().ToStringOutput(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				serviceRange.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudids.NewEndpoint(ctx, "example-endpoint", &cloudids.EndpointArgs{
			Name:     pulumi.String("test"),
			Location: pulumi.String("us-central1-f"),
			Network:  _default.ID().ToIDOutput().ToStringOutput(),
			Severity: pulumi.String("INFORMATIONAL"),
		}, pulumi.DependsOn([]pulumi.Resource{
			privateServiceConnection,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_network" "default" {
  name = "tf-test-my-network"
}
resource "gcp_compute_globaladdress" "service_range" {
  name          = "address"
  purpose       = "VPC_PEERING"
  address_type  = "INTERNAL"
  prefix_length = 16
  network       = gcp_compute_network.default.id
}
resource "gcp_servicenetworking_connection" "private_service_connection" {
  network                 = gcp_compute_network.default.id
  service                 = "servicenetworking.googleapis.com"
  reserved_peering_ranges = [gcp_compute_globaladdress.service_range.name]
}
resource "gcp_cloudids_endpoint" "example-endpoint" {
  depends_on = [gcp_servicenetworking_connection.private_service_connection]
  name       = "test"
  location   = "us-central1-f"
  network    = gcp_compute_network.default.id
  severity   = "INFORMATIONAL"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.cloudids.Endpoint;
import com.pulumi.gcp.cloudids.EndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 default_ = new Network("default", NetworkArgs.builder()
            .name("tf-test-my-network")
            .build());

        var serviceRange = new GlobalAddress("serviceRange", GlobalAddressArgs.builder()
            .name("address")
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(default_.id())
            .build());

        var privateServiceConnection = new Connection("privateServiceConnection", ConnectionArgs.builder()
            .network(default_.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(serviceRange.name())
            .build());

        var example_endpoint = new Endpoint("example-endpoint", EndpointArgs.builder()
            .name("test")
            .location("us-central1-f")
            .network(default_.id())
            .severity("INFORMATIONAL")
            .build(), CustomResourceOptions.builder()
                .dependsOn(privateServiceConnection)
                .build());

    }
}

resources:
  default:
    type: gcp:compute:Network
    properties:
      name: tf-test-my-network
  serviceRange:
    type: gcp:compute:GlobalAddress
    name: service_range
    properties:
      name: address
      purpose: VPC_PEERING
      addressType: INTERNAL
      prefixLength: 16
      network: ${default.id}
  privateServiceConnection:
    type: gcp:servicenetworking:Connection
    name: private_service_connection
    properties:
      network: ${default.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${serviceRange.name}
  example-endpoint:
    type: gcp:cloudids:Endpoint
    properties:
      name: test
      location: us-central1-f
      network: ${default.id}
      severity: INFORMATIONAL
    options:
      dependsOn:
        - ${privateServiceConnection}

Import

Endpoint can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/endpoints/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}

When using the pulumi import command, Endpoint can be imported using one of the formats above. For example:

$ pulumi import gcp:cloudids/endpoint:Endpoint default projects/{{project}}/locations/{{location}}/endpoints/{{name}}
$ pulumi import gcp:cloudids/endpoint:Endpoint default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:cloudids/endpoint:Endpoint default {{location}}/{{name}}

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

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Creation timestamp in RFC 3339 text format.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional description of the endpoint.
latefinal
endpointForwardingRule ↔ Output<String>: URL of the endpoint's network address to which traffic is to be sent by Packet Mirroring.
latefinal
endpointIp ↔ Output<String>: Internal IP address of the endpoint's network entry point.
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
location ↔ Output<String>: The location for the endpoint.
latefinal
name ↔ Output<String>: Name of the endpoint in the format projects/{project_id}/locations/{locationId}/endpoints/{endpointId}.
latefinal
network ↔ Output<String>: Name of the VPC network that is connected to the IDS endpoint. This can either contain the VPC network name itself (like "src-net") or the full URL to the network (like "projects/{project_id}/global/networks/src-net").
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
severity ↔ Output<String>: The minimum alert severity level that is reported by the endpoint. Possible values are: INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
latefinal
threatExceptions ↔ Output<List<String>?>: Configuration for threat IDs excluded from generating alerts. Limit: 99 IDs.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>: Last update timestamp in RFC 3339 text format.
latefinal
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.