Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. network
  5. Zone
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

okta.network.Zone

Explore with Pulumi AI

okta logo
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

    Creates an Okta Network Zone. This resource allows you to create and configure an Okta Network Zone.

    Create Zone Resource

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

    Constructor syntax

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

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         type: Optional[str] = None,
         asns: Optional[Sequence[str]] = None,
         dynamic_locations: Optional[Sequence[str]] = None,
         dynamic_proxy_type: Optional[str] = None,
         gateways: Optional[Sequence[str]] = None,
         name: Optional[str] = None,
         proxies: Optional[Sequence[str]] = None,
         status: Optional[str] = None,
         usage: Optional[str] = None)
    func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)

    type: okta:network:Zone
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 ZoneArgs
    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 ZoneArgs
    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 ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneArgs
    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 zoneResource = new Okta.Network.Zone("zoneResource", new()
{
    Type = "string",
    Asns = new[]
    {
        "string",
    },
    DynamicLocations = new[]
    {
        "string",
    },
    DynamicProxyType = "string",
    Gateways = new[]
    {
        "string",
    },
    Name = "string",
    Proxies = new[]
    {
        "string",
    },
    Status = "string",
    Usage = "string",
});

    example, err := network.NewZone(ctx, "zoneResource", &network.ZoneArgs{
	Type: pulumi.String("string"),
	Asns: pulumi.StringArray{
		pulumi.String("string"),
	},
	DynamicLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	DynamicProxyType: pulumi.String("string"),
	Gateways: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Proxies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Usage:  pulumi.String("string"),
})

    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .type("string")
    .asns("string")
    .dynamicLocations("string")
    .dynamicProxyType("string")
    .gateways("string")
    .name("string")
    .proxies("string")
    .status("string")
    .usage("string")
    .build());

    zone_resource = okta.network.Zone("zoneResource",
    type="string",
    asns=["string"],
    dynamic_locations=["string"],
    dynamic_proxy_type="string",
    gateways=["string"],
    name="string",
    proxies=["string"],
    status="string",
    usage="string")

    const zoneResource = new okta.network.Zone("zoneResource", {
    type: "string",
    asns: ["string"],
    dynamicLocations: ["string"],
    dynamicProxyType: "string",
    gateways: ["string"],
    name: "string",
    proxies: ["string"],
    status: "string",
    usage: "string",
});

    type: okta:network:Zone
properties:
    asns:
        - string
    dynamicLocations:
        - string
    dynamicProxyType: string
    gateways:
        - string
    name: string
    proxies:
        - string
    status: string
    type: string
    usage: string

    Zone 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 Zone resource accepts the following input properties:

    Type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    Asns List<string>
    Format of each array value: a string representation of an ASN numeric value
    DynamicLocations List<string>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    Gateways List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    Name string
    Name of the Network Zone Resource
    Proxies List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    Type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    Asns []string
    Format of each array value: a string representation of an ASN numeric value
    DynamicLocations []string
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    Gateways []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    Name string
    Name of the Network Zone Resource
    Proxies []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    type String
    Type of the Network Zone - can either be IP or DYNAMIC only
    asns List<String>
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name String
    Name of the Network Zone Resource
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    usage String
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    asns string[]
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations string[]
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name string
    Name of the Network Zone Resource
    proxies string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status string
    Network Status - can either be ACTIVE or INACTIVE only
    usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    type str
    Type of the Network Zone - can either be IP or DYNAMIC only
    asns Sequence[str]
    Format of each array value: a string representation of an ASN numeric value
    dynamic_locations Sequence[str]
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamic_proxy_type str
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name str
    Name of the Network Zone Resource
    proxies Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status str
    Network Status - can either be ACTIVE or INACTIVE only
    usage str
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    type String
    Type of the Network Zone - can either be IP or DYNAMIC only
    asns List<String>
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name String
    Name of the Network Zone Resource
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    usage String
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Zone Resource

    Get an existing Zone 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?: ZoneState, opts?: CustomResourceOptions): Zone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asns: Optional[Sequence[str]] = None,
        dynamic_locations: Optional[Sequence[str]] = None,
        dynamic_proxy_type: Optional[str] = None,
        gateways: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        proxies: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        usage: Optional[str] = None) -> Zone
    func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
    public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
    public static Zone get(String name, Output<String> id, ZoneState 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:
    Asns List<string>
    Format of each array value: a string representation of an ASN numeric value
    DynamicLocations List<string>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    Gateways List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    Name string
    Name of the Network Zone Resource
    Proxies List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    Usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    Asns []string
    Format of each array value: a string representation of an ASN numeric value
    DynamicLocations []string
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    Gateways []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    Name string
    Name of the Network Zone Resource
    Proxies []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    Usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    asns List<String>
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name String
    Name of the Network Zone Resource
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    type String
    Type of the Network Zone - can either be IP or DYNAMIC only
    usage String
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    asns string[]
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations string[]
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name string
    Name of the Network Zone Resource
    proxies string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status string
    Network Status - can either be ACTIVE or INACTIVE only
    type string
    Type of the Network Zone - can either be IP or DYNAMIC only
    usage string
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    asns Sequence[str]
    Format of each array value: a string representation of an ASN numeric value
    dynamic_locations Sequence[str]
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamic_proxy_type str
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name str
    Name of the Network Zone Resource
    proxies Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status str
    Network Status - can either be ACTIVE or INACTIVE only
    type str
    Type of the Network Zone - can either be IP or DYNAMIC only
    usage str
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY
    asns List<String>
    Format of each array value: a string representation of an ASN numeric value
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2). Format code: countryCode OR countryCode-regionCode
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer.
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples
    name String
    Name of the Network Zone Resource
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    type String
    Type of the Network Zone - can either be IP or DYNAMIC only
    usage String
    Usage of the Network Zone - can be either POLICY or BLOCKLIST. By default, it is POLICY

    Import

    $ pulumi import okta:network/zone:Zone example &#60;zone id&#62;

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
    pulumi/pulumi-okta