Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. NetworkPolicy
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.NetworkPolicy

Explore with Pulumi AI

snowflake logo
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/networkPolicy:NetworkPolicy example "name"

    Create NetworkPolicy Resource

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

    Constructor syntax

    new NetworkPolicy(name: string, args?: NetworkPolicyArgs, opts?: CustomResourceOptions);
    @overload
def NetworkPolicy(resource_name: str,
                  args: Optional[NetworkPolicyArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def NetworkPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  allowed_ip_lists: Optional[Sequence[str]] = None,
                  allowed_network_rule_lists: Optional[Sequence[str]] = None,
                  blocked_ip_lists: Optional[Sequence[str]] = None,
                  blocked_network_rule_lists: Optional[Sequence[str]] = None,
                  comment: Optional[str] = None,
                  name: Optional[str] = None)
    func NewNetworkPolicy(ctx *Context, name string, args *NetworkPolicyArgs, opts ...ResourceOption) (*NetworkPolicy, error)
    public NetworkPolicy(string name, NetworkPolicyArgs? args = null, CustomResourceOptions? opts = null)
    public NetworkPolicy(String name, NetworkPolicyArgs args)
public NetworkPolicy(String name, NetworkPolicyArgs args, CustomResourceOptions options)

    type: snowflake:NetworkPolicy
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 NetworkPolicyArgs
    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 NetworkPolicyArgs
    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 NetworkPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var networkPolicyResource = new Snowflake.NetworkPolicy("networkPolicyResource", new()
{
    AllowedIpLists = new[]
    {
        "string",
    },
    AllowedNetworkRuleLists = new[]
    {
        "string",
    },
    BlockedIpLists = new[]
    {
        "string",
    },
    BlockedNetworkRuleLists = new[]
    {
        "string",
    },
    Comment = "string",
    Name = "string",
});

    example, err := snowflake.NewNetworkPolicy(ctx, "networkPolicyResource", &snowflake.NetworkPolicyArgs{
	AllowedIpLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowedNetworkRuleLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	BlockedIpLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	BlockedNetworkRuleLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    var networkPolicyResource = new NetworkPolicy("networkPolicyResource", NetworkPolicyArgs.builder()
    .allowedIpLists("string")
    .allowedNetworkRuleLists("string")
    .blockedIpLists("string")
    .blockedNetworkRuleLists("string")
    .comment("string")
    .name("string")
    .build());

    network_policy_resource = snowflake.NetworkPolicy("networkPolicyResource",
    allowed_ip_lists=["string"],
    allowed_network_rule_lists=["string"],
    blocked_ip_lists=["string"],
    blocked_network_rule_lists=["string"],
    comment="string",
    name="string")

    const networkPolicyResource = new snowflake.NetworkPolicy("networkPolicyResource", {
    allowedIpLists: ["string"],
    allowedNetworkRuleLists: ["string"],
    blockedIpLists: ["string"],
    blockedNetworkRuleLists: ["string"],
    comment: "string",
    name: "string",
});

    type: snowflake:NetworkPolicy
properties:
    allowedIpLists:
        - string
    allowedNetworkRuleLists:
        - string
    blockedIpLists:
        - string
    blockedNetworkRuleLists:
        - string
    comment: string
    name: string

    NetworkPolicy Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NetworkPolicy resource accepts the following input properties:

    AllowedIpLists List<string>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    AllowedNetworkRuleLists List<string>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    BlockedIpLists List<string>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    BlockedNetworkRuleLists List<string>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    Comment string
    Specifies a comment for the network policy.
    Name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    AllowedIpLists []string
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    AllowedNetworkRuleLists []string
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    BlockedIpLists []string
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    BlockedNetworkRuleLists []string
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    Comment string
    Specifies a comment for the network policy.
    Name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    allowedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment String
    Specifies a comment for the network policy.
    name String
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    allowedIpLists string[]
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists string[]
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists string[]
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists string[]
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment string
    Specifies a comment for the network policy.
    name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    allowed_ip_lists Sequence[str]
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowed_network_rule_lists Sequence[str]
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blocked_ip_lists Sequence[str]
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blocked_network_rule_lists Sequence[str]
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment str
    Specifies a comment for the network policy.
    name str
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    allowedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment String
    Specifies a comment for the network policy.
    name String
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

    Outputs

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

    DescribeOutputs List<NetworkPolicyDescribeOutput>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs List<NetworkPolicyShowOutput>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    DescribeOutputs []NetworkPolicyDescribeOutput
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs []NetworkPolicyShowOutput
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    describeOutputs List<NetworkPolicyDescribeOutput>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<NetworkPolicyShowOutput>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    describeOutputs NetworkPolicyDescribeOutput[]
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    showOutputs NetworkPolicyShowOutput[]
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    describe_outputs Sequence[NetworkPolicyDescribeOutput]
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    show_outputs Sequence[NetworkPolicyShowOutput]
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<Property Map>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.

    Look up Existing NetworkPolicy Resource

    Get an existing NetworkPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NetworkPolicyState, opts?: CustomResourceOptions): NetworkPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_ip_lists: Optional[Sequence[str]] = None,
        allowed_network_rule_lists: Optional[Sequence[str]] = None,
        blocked_ip_lists: Optional[Sequence[str]] = None,
        blocked_network_rule_lists: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[NetworkPolicyDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        show_outputs: Optional[Sequence[NetworkPolicyShowOutputArgs]] = None) -> NetworkPolicy
    func GetNetworkPolicy(ctx *Context, name string, id IDInput, state *NetworkPolicyState, opts ...ResourceOption) (*NetworkPolicy, error)
    public static NetworkPolicy Get(string name, Input<string> id, NetworkPolicyState? state, CustomResourceOptions? opts = null)
    public static NetworkPolicy get(String name, Output<String> id, NetworkPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedIpLists List<string>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    AllowedNetworkRuleLists List<string>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    BlockedIpLists List<string>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    BlockedNetworkRuleLists List<string>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    Comment string
    Specifies a comment for the network policy.
    DescribeOutputs List<NetworkPolicyDescribeOutput>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    ShowOutputs List<NetworkPolicyShowOutput>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    AllowedIpLists []string
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    AllowedNetworkRuleLists []string
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    BlockedIpLists []string
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    BlockedNetworkRuleLists []string
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    Comment string
    Specifies a comment for the network policy.
    DescribeOutputs []NetworkPolicyDescribeOutputArgs
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    ShowOutputs []NetworkPolicyShowOutputArgs
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    allowedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment String
    Specifies a comment for the network policy.
    describeOutputs List<NetworkPolicyDescribeOutput>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    showOutputs List<NetworkPolicyShowOutput>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    allowedIpLists string[]
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists string[]
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists string[]
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists string[]
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment string
    Specifies a comment for the network policy.
    describeOutputs NetworkPolicyDescribeOutput[]
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    showOutputs NetworkPolicyShowOutput[]
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    allowed_ip_lists Sequence[str]
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowed_network_rule_lists Sequence[str]
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blocked_ip_lists Sequence[str]
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blocked_network_rule_lists Sequence[str]
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment str
    Specifies a comment for the network policy.
    describe_outputs Sequence[NetworkPolicyDescribeOutputArgs]
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    show_outputs Sequence[NetworkPolicyShowOutputArgs]
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.
    allowedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are allowed access to your Snowflake account.
    allowedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are allowed access to Snowflake.
    blockedIpLists List<String>
    Specifies one or more IPv4 addresses (CIDR notation) that are denied access to your Snowflake account. Do not add 0.0.0.0/0 to blocked_ip_list, in order to block all IP addresses except a select list, you only need to add IP addresses to allowed_ip_list.
    blockedNetworkRuleLists List<String>
    Specifies a list of fully qualified network rules that contain the network identifiers that are denied access to Snowflake.
    comment String
    Specifies a comment for the network policy.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE NETWORK POLICY for the given network policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the network policy; must be unique for the account in which the network policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    showOutputs List<Property Map>
    Outputs the result of SHOW NETWORK POLICIES for the given network policy.

    Supporting Types

    NetworkPolicyDescribeOutput, NetworkPolicyDescribeOutputArgs

    NetworkPolicyShowOutput, NetworkPolicyShowOutputArgs

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-snowflake