1. Packages
  2. Google Cloud Native
  3. API Docs
  4. ids
  5. ids/v1
  6. Endpoint

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.ids/v1.Endpoint

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new Endpoint in a given project and location. Auto-naming is currently not supported for this resource.

    Create Endpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Endpoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 endpoint_id: Optional[str] = None,
                 network: Optional[str] = None,
                 severity: Optional[EndpointSeverity] = None,
                 description: Optional[str] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 request_id: Optional[str] = None,
                 threat_exceptions: Optional[Sequence[str]] = None,
                 traffic_logs: Optional[bool] = None)
    func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
    public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
    public Endpoint(String name, EndpointArgs args)
    public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
    
    type: google-native:ids/v1:Endpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleendpointResourceResourceFromIdsv1 = new GoogleNative.IDS.V1.Endpoint("exampleendpointResourceResourceFromIdsv1", new()
    {
        EndpointId = "string",
        Network = "string",
        Severity = GoogleNative.IDS.V1.EndpointSeverity.SeverityUnspecified,
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Project = "string",
        RequestId = "string",
        ThreatExceptions = new[]
        {
            "string",
        },
        TrafficLogs = false,
    });
    
    example, err := ids.NewEndpoint(ctx, "exampleendpointResourceResourceFromIdsv1", &ids.EndpointArgs{
    EndpointId: pulumi.String("string"),
    Network: pulumi.String("string"),
    Severity: ids.EndpointSeveritySeverityUnspecified,
    Description: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    RequestId: pulumi.String("string"),
    ThreatExceptions: pulumi.StringArray{
    pulumi.String("string"),
    },
    TrafficLogs: pulumi.Bool(false),
    })
    
    var exampleendpointResourceResourceFromIdsv1 = new Endpoint("exampleendpointResourceResourceFromIdsv1", EndpointArgs.builder()
        .endpointId("string")
        .network("string")
        .severity("SEVERITY_UNSPECIFIED")
        .description("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .project("string")
        .requestId("string")
        .threatExceptions("string")
        .trafficLogs(false)
        .build());
    
    exampleendpoint_resource_resource_from_idsv1 = google_native.ids.v1.Endpoint("exampleendpointResourceResourceFromIdsv1",
        endpoint_id="string",
        network="string",
        severity=google_native.ids.v1.EndpointSeverity.SEVERITY_UNSPECIFIED,
        description="string",
        labels={
            "string": "string",
        },
        location="string",
        project="string",
        request_id="string",
        threat_exceptions=["string"],
        traffic_logs=False)
    
    const exampleendpointResourceResourceFromIdsv1 = new google_native.ids.v1.Endpoint("exampleendpointResourceResourceFromIdsv1", {
        endpointId: "string",
        network: "string",
        severity: google_native.ids.v1.EndpointSeverity.SeverityUnspecified,
        description: "string",
        labels: {
            string: "string",
        },
        location: "string",
        project: "string",
        requestId: "string",
        threatExceptions: ["string"],
        trafficLogs: false,
    });
    
    type: google-native:ids/v1:Endpoint
    properties:
        description: string
        endpointId: string
        labels:
            string: string
        location: string
        network: string
        project: string
        requestId: string
        severity: SEVERITY_UNSPECIFIED
        threatExceptions:
            - string
        trafficLogs: false
    

    Endpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Endpoint resource accepts the following input properties:

    EndpointId string
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    Network string
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    Severity Pulumi.GoogleNative.IDS.V1.EndpointSeverity
    Lowest threat severity that this endpoint will alert on.
    Description string
    User-provided description of the endpoint
    Labels Dictionary<string, string>
    The labels of the endpoint.
    Location string
    Project string
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    ThreatExceptions List<string>
    List of threat IDs to be excepted from generating alerts.
    TrafficLogs bool
    Whether the endpoint should report traffic logs in addition to threat logs.
    EndpointId string
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    Network string
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    Severity EndpointSeverity
    Lowest threat severity that this endpoint will alert on.
    Description string
    User-provided description of the endpoint
    Labels map[string]string
    The labels of the endpoint.
    Location string
    Project string
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    ThreatExceptions []string
    List of threat IDs to be excepted from generating alerts.
    TrafficLogs bool
    Whether the endpoint should report traffic logs in addition to threat logs.
    endpointId String
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    network String
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    severity EndpointSeverity
    Lowest threat severity that this endpoint will alert on.
    description String
    User-provided description of the endpoint
    labels Map<String,String>
    The labels of the endpoint.
    location String
    project String
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    threatExceptions List<String>
    List of threat IDs to be excepted from generating alerts.
    trafficLogs Boolean
    Whether the endpoint should report traffic logs in addition to threat logs.
    endpointId string
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    network string
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    severity EndpointSeverity
    Lowest threat severity that this endpoint will alert on.
    description string
    User-provided description of the endpoint
    labels {[key: string]: string}
    The labels of the endpoint.
    location string
    project string
    requestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    threatExceptions string[]
    List of threat IDs to be excepted from generating alerts.
    trafficLogs boolean
    Whether the endpoint should report traffic logs in addition to threat logs.
    endpoint_id str
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    network str
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    severity EndpointSeverity
    Lowest threat severity that this endpoint will alert on.
    description str
    User-provided description of the endpoint
    labels Mapping[str, str]
    The labels of the endpoint.
    location str
    project str
    request_id str
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    threat_exceptions Sequence[str]
    List of threat IDs to be excepted from generating alerts.
    traffic_logs bool
    Whether the endpoint should report traffic logs in addition to threat logs.
    endpointId String
    Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
    network String
    The fully qualified URL of the network to which the IDS Endpoint is attached.
    severity "SEVERITY_UNSPECIFIED" | "INFORMATIONAL" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
    Lowest threat severity that this endpoint will alert on.
    description String
    User-provided description of the endpoint
    labels Map<String>
    The labels of the endpoint.
    location String
    project String
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    threatExceptions List<String>
    List of threat IDs to be excepted from generating alerts.
    trafficLogs Boolean
    Whether the endpoint should report traffic logs in addition to threat logs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

    CreateTime string
    The create time timestamp.
    EndpointForwardingRule string
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    EndpointIp string
    The IP address of the IDS Endpoint's ILB.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the endpoint.
    State string
    Current state of the endpoint.
    UpdateTime string
    The update time timestamp.
    CreateTime string
    The create time timestamp.
    EndpointForwardingRule string
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    EndpointIp string
    The IP address of the IDS Endpoint's ILB.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the endpoint.
    State string
    Current state of the endpoint.
    UpdateTime string
    The update time timestamp.
    createTime String
    The create time timestamp.
    endpointForwardingRule String
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    endpointIp String
    The IP address of the IDS Endpoint's ILB.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the endpoint.
    state String
    Current state of the endpoint.
    updateTime String
    The update time timestamp.
    createTime string
    The create time timestamp.
    endpointForwardingRule string
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    endpointIp string
    The IP address of the IDS Endpoint's ILB.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the endpoint.
    state string
    Current state of the endpoint.
    updateTime string
    The update time timestamp.
    create_time str
    The create time timestamp.
    endpoint_forwarding_rule str
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    endpoint_ip str
    The IP address of the IDS Endpoint's ILB.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the endpoint.
    state str
    Current state of the endpoint.
    update_time str
    The update time timestamp.
    createTime String
    The create time timestamp.
    endpointForwardingRule String
    The fully qualified URL of the endpoint's ILB Forwarding Rule.
    endpointIp String
    The IP address of the IDS Endpoint's ILB.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the endpoint.
    state String
    Current state of the endpoint.
    updateTime String
    The update time timestamp.

    Supporting Types

    EndpointSeverity, EndpointSeverityArgs

    SeverityUnspecified
    SEVERITY_UNSPECIFIEDNot set.
    Informational
    INFORMATIONALInformational alerts.
    Low
    LOWLow severity alerts.
    Medium
    MEDIUMMedium severity alerts.
    High
    HIGHHigh severity alerts.
    Critical
    CRITICALCritical severity alerts.
    EndpointSeveritySeverityUnspecified
    SEVERITY_UNSPECIFIEDNot set.
    EndpointSeverityInformational
    INFORMATIONALInformational alerts.
    EndpointSeverityLow
    LOWLow severity alerts.
    EndpointSeverityMedium
    MEDIUMMedium severity alerts.
    EndpointSeverityHigh
    HIGHHigh severity alerts.
    EndpointSeverityCritical
    CRITICALCritical severity alerts.
    SeverityUnspecified
    SEVERITY_UNSPECIFIEDNot set.
    Informational
    INFORMATIONALInformational alerts.
    Low
    LOWLow severity alerts.
    Medium
    MEDIUMMedium severity alerts.
    High
    HIGHHigh severity alerts.
    Critical
    CRITICALCritical severity alerts.
    SeverityUnspecified
    SEVERITY_UNSPECIFIEDNot set.
    Informational
    INFORMATIONALInformational alerts.
    Low
    LOWLow severity alerts.
    Medium
    MEDIUMMedium severity alerts.
    High
    HIGHHigh severity alerts.
    Critical
    CRITICALCritical severity alerts.
    SEVERITY_UNSPECIFIED
    SEVERITY_UNSPECIFIEDNot set.
    INFORMATIONAL
    INFORMATIONALInformational alerts.
    LOW
    LOWLow severity alerts.
    MEDIUM
    MEDIUMMedium severity alerts.
    HIGH
    HIGHHigh severity alerts.
    CRITICAL
    CRITICALCritical severity alerts.
    "SEVERITY_UNSPECIFIED"
    SEVERITY_UNSPECIFIEDNot set.
    "INFORMATIONAL"
    INFORMATIONALInformational alerts.
    "LOW"
    LOWLow severity alerts.
    "MEDIUM"
    MEDIUMMedium severity alerts.
    "HIGH"
    HIGHHigh severity alerts.
    "CRITICAL"
    CRITICALCritical severity alerts.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi