1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyGatewayFloodProtectionProfile
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.getPolicyGatewayFloodProtectionProfile

Explore with Pulumi AI

This data source provides information about policy Gateway Flood Protection Profile configured in NSX. This data source is applicable to NSX Global Manager and NSX Policy Manager.

Example Usage

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

const test = new nsxt.PolicyGatewayFloodProtectionProfile("test", {displayName: "test"});
Copy
import pulumi
import pulumi_nsxt as nsxt

test = nsxt.PolicyGatewayFloodProtectionProfile("test", display_name="test")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nsxt.NewPolicyGatewayFloodProtectionProfile(ctx, "test", &nsxt.PolicyGatewayFloodProtectionProfileArgs{
			DisplayName: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var test = new Nsxt.PolicyGatewayFloodProtectionProfile("test", new()
    {
        DisplayName = "test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.PolicyGatewayFloodProtectionProfile;
import com.pulumi.nsxt.PolicyGatewayFloodProtectionProfileArgs;
import java.util.List;
import java.util.ArrayList;
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 test = new PolicyGatewayFloodProtectionProfile("test", PolicyGatewayFloodProtectionProfileArgs.builder()
            .displayName("test")
            .build());

    }
}
Copy
resources:
  test:
    type: nsxt:PolicyGatewayFloodProtectionProfile
    properties:
      displayName: test
Copy

Multi-Tenancy

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

const demoproj = nsxt.getPolicyProject({
    displayName: "demoproj",
});
const test = new nsxt.PolicyGatewayFloodProtectionProfile("test", {
    context: {
        projectId: demoproj.then(demoproj => demoproj.id),
    },
    displayName: "test",
});
Copy
import pulumi
import pulumi_nsxt as nsxt

demoproj = nsxt.get_policy_project(display_name="demoproj")
test = nsxt.PolicyGatewayFloodProtectionProfile("test",
    context={
        "project_id": demoproj.id,
    },
    display_name="test")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		demoproj, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{
			DisplayName: pulumi.StringRef("demoproj"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nsxt.NewPolicyGatewayFloodProtectionProfile(ctx, "test", &nsxt.PolicyGatewayFloodProtectionProfileArgs{
			Context: &nsxt.PolicyGatewayFloodProtectionProfileContextArgs{
				ProjectId: pulumi.String(demoproj.Id),
			},
			DisplayName: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var demoproj = Nsxt.GetPolicyProject.Invoke(new()
    {
        DisplayName = "demoproj",
    });

    var test = new Nsxt.PolicyGatewayFloodProtectionProfile("test", new()
    {
        Context = new Nsxt.Inputs.PolicyGatewayFloodProtectionProfileContextArgs
        {
            ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
        },
        DisplayName = "test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetPolicyProjectArgs;
import com.pulumi.nsxt.PolicyGatewayFloodProtectionProfile;
import com.pulumi.nsxt.PolicyGatewayFloodProtectionProfileArgs;
import com.pulumi.nsxt.inputs.PolicyGatewayFloodProtectionProfileContextArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var demoproj = NsxtFunctions.getPolicyProject(GetPolicyProjectArgs.builder()
            .displayName("demoproj")
            .build());

        var test = new PolicyGatewayFloodProtectionProfile("test", PolicyGatewayFloodProtectionProfileArgs.builder()
            .context(PolicyGatewayFloodProtectionProfileContextArgs.builder()
                .projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
                .build())
            .displayName("test")
            .build());

    }
}
Copy
resources:
  test:
    type: nsxt:PolicyGatewayFloodProtectionProfile
    properties:
      context:
        projectId: ${demoproj.id}
      displayName: test
variables:
  demoproj:
    fn::invoke:
      function: nsxt:getPolicyProject
      arguments:
        displayName: demoproj
Copy

Using getPolicyGatewayFloodProtectionProfile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPolicyGatewayFloodProtectionProfile(args: GetPolicyGatewayFloodProtectionProfileArgs, opts?: InvokeOptions): Promise<GetPolicyGatewayFloodProtectionProfileResult>
function getPolicyGatewayFloodProtectionProfileOutput(args: GetPolicyGatewayFloodProtectionProfileOutputArgs, opts?: InvokeOptions): Output<GetPolicyGatewayFloodProtectionProfileResult>
Copy
def get_policy_gateway_flood_protection_profile(context: Optional[GetPolicyGatewayFloodProtectionProfileContext] = None,
                                                description: Optional[str] = None,
                                                display_name: Optional[str] = None,
                                                id: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetPolicyGatewayFloodProtectionProfileResult
def get_policy_gateway_flood_protection_profile_output(context: Optional[pulumi.Input[GetPolicyGatewayFloodProtectionProfileContextArgs]] = None,
                                                description: Optional[pulumi.Input[str]] = None,
                                                display_name: Optional[pulumi.Input[str]] = None,
                                                id: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetPolicyGatewayFloodProtectionProfileResult]
Copy
func LookupPolicyGatewayFloodProtectionProfile(ctx *Context, args *LookupPolicyGatewayFloodProtectionProfileArgs, opts ...InvokeOption) (*LookupPolicyGatewayFloodProtectionProfileResult, error)
func LookupPolicyGatewayFloodProtectionProfileOutput(ctx *Context, args *LookupPolicyGatewayFloodProtectionProfileOutputArgs, opts ...InvokeOption) LookupPolicyGatewayFloodProtectionProfileResultOutput
Copy

> Note: This function is named LookupPolicyGatewayFloodProtectionProfile in the Go SDK.

public static class GetPolicyGatewayFloodProtectionProfile 
{
    public static Task<GetPolicyGatewayFloodProtectionProfileResult> InvokeAsync(GetPolicyGatewayFloodProtectionProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyGatewayFloodProtectionProfileResult> Invoke(GetPolicyGatewayFloodProtectionProfileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPolicyGatewayFloodProtectionProfileResult> getPolicyGatewayFloodProtectionProfile(GetPolicyGatewayFloodProtectionProfileArgs args, InvokeOptions options)
public static Output<GetPolicyGatewayFloodProtectionProfileResult> getPolicyGatewayFloodProtectionProfile(GetPolicyGatewayFloodProtectionProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getPolicyGatewayFloodProtectionProfile:getPolicyGatewayFloodProtectionProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Context GetPolicyGatewayFloodProtectionProfileContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
Id string
The ID of Gateway Flood Protection Profile to retrieve.
Context GetPolicyGatewayFloodProtectionProfileContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
Id string
The ID of Gateway Flood Protection Profile to retrieve.
context GetPolicyGatewayFloodProtectionProfileContext
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
id String
The ID of Gateway Flood Protection Profile to retrieve.
context GetPolicyGatewayFloodProtectionProfileContext
The context which the object belongs to
description string
The description of the resource.
displayName string
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
id string
The ID of Gateway Flood Protection Profile to retrieve.
context GetPolicyGatewayFloodProtectionProfileContext
The context which the object belongs to
description str
The description of the resource.
display_name str
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
id str
The ID of Gateway Flood Protection Profile to retrieve.
context Property Map
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
id String
The ID of Gateway Flood Protection Profile to retrieve.

getPolicyGatewayFloodProtectionProfile Result

The following output properties are available:

Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
Context GetPolicyGatewayFloodProtectionProfileContext
Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
Context GetPolicyGatewayFloodProtectionProfileContext
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
context GetPolicyGatewayFloodProtectionProfileContext
description string
The description of the resource.
displayName string
id string
path string
The NSX path of the policy resource.
context GetPolicyGatewayFloodProtectionProfileContext
description str
The description of the resource.
display_name str
id str
path str
The NSX path of the policy resource.
context GetPolicyGatewayFloodProtectionProfileContext
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
context Property Map

Supporting Types

GetPolicyGatewayFloodProtectionProfileContext

ProjectId This property is required. string
The ID of the project which the object belongs to
ProjectId This property is required. string
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to
projectId This property is required. string
The ID of the project which the object belongs to
project_id This property is required. str
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.