Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwAclPolicyV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ApigwAclPolicyV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for API Gateway Acl service you can get at documentation portal

    Manages an APIGW ACL policy resource within OpenTelekomCloud.

    Example Usage

    Create ApigwAclPolicyV2 Resource

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

    Constructor syntax

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

@overload
def ApigwAclPolicyV2(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     entity_type: Optional[str] = None,
                     gateway_id: Optional[str] = None,
                     type: Optional[str] = None,
                     value: Optional[str] = None,
                     apigw_acl_policy_v2_id: Optional[str] = None,
                     name: Optional[str] = None)
    func NewApigwAclPolicyV2(ctx *Context, name string, args ApigwAclPolicyV2Args, opts ...ResourceOption) (*ApigwAclPolicyV2, error)
    public ApigwAclPolicyV2(string name, ApigwAclPolicyV2Args args, CustomResourceOptions? opts = null)
    public ApigwAclPolicyV2(String name, ApigwAclPolicyV2Args args)
public ApigwAclPolicyV2(String name, ApigwAclPolicyV2Args args, CustomResourceOptions options)

    type: opentelekomcloud:ApigwAclPolicyV2
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 ApigwAclPolicyV2Args
    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 ApigwAclPolicyV2Args
    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 ApigwAclPolicyV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwAclPolicyV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwAclPolicyV2Args
    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 apigwAclPolicyV2Resource = new Opentelekomcloud.ApigwAclPolicyV2("apigwAclPolicyV2Resource", new()
{
    EntityType = "string",
    GatewayId = "string",
    Type = "string",
    Value = "string",
    ApigwAclPolicyV2Id = "string",
    Name = "string",
});

    example, err := opentelekomcloud.NewApigwAclPolicyV2(ctx, "apigwAclPolicyV2Resource", &opentelekomcloud.ApigwAclPolicyV2Args{
	EntityType:         pulumi.String("string"),
	GatewayId:          pulumi.String("string"),
	Type:               pulumi.String("string"),
	Value:              pulumi.String("string"),
	ApigwAclPolicyV2Id: pulumi.String("string"),
	Name:               pulumi.String("string"),
})

    var apigwAclPolicyV2Resource = new ApigwAclPolicyV2("apigwAclPolicyV2Resource", ApigwAclPolicyV2Args.builder()
    .entityType("string")
    .gatewayId("string")
    .type("string")
    .value("string")
    .apigwAclPolicyV2Id("string")
    .name("string")
    .build());

    apigw_acl_policy_v2_resource = opentelekomcloud.ApigwAclPolicyV2("apigwAclPolicyV2Resource",
    entity_type="string",
    gateway_id="string",
    type="string",
    value="string",
    apigw_acl_policy_v2_id="string",
    name="string")

    const apigwAclPolicyV2Resource = new opentelekomcloud.ApigwAclPolicyV2("apigwAclPolicyV2Resource", {
    entityType: "string",
    gatewayId: "string",
    type: "string",
    value: "string",
    apigwAclPolicyV2Id: "string",
    name: "string",
});

    type: opentelekomcloud:ApigwAclPolicyV2
properties:
    apigwAclPolicyV2Id: string
    entityType: string
    gatewayId: string
    name: string
    type: string
    value: string

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

    EntityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    GatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    Type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    Value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    ApigwAclPolicyV2Id string
    The ID of the ACL policy.
    Name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    EntityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    GatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    Type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    Value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    ApigwAclPolicyV2Id string
    The ID of the ACL policy.
    Name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    entityType String
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId String
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    type String
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    value String
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id String
    The ID of the ACL policy.
    name String
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    entityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id string
    The ID of the ACL policy.
    name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    entity_type str
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gateway_id str
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    type str
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    value str
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigw_acl_policy_v2_id str
    The ID of the ACL policy.
    name str
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    entityType String
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId String
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    type String
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    value String
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id String
    The ID of the ACL policy.
    name String
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the ACL policy is located.
    UpdatedAt string
    The latest update time of the ACL policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the ACL policy is located.
    UpdatedAt string
    The latest update time of the ACL policy.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the ACL policy is located.
    updatedAt String
    The latest update time of the ACL policy.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    The region where the ACL policy is located.
    updatedAt string
    The latest update time of the ACL policy.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    The region where the ACL policy is located.
    updated_at str
    The latest update time of the ACL policy.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the ACL policy is located.
    updatedAt String
    The latest update time of the ACL policy.

    Look up Existing ApigwAclPolicyV2 Resource

    Get an existing ApigwAclPolicyV2 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?: ApigwAclPolicyV2State, opts?: CustomResourceOptions): ApigwAclPolicyV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apigw_acl_policy_v2_id: Optional[str] = None,
        entity_type: Optional[str] = None,
        gateway_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        value: Optional[str] = None) -> ApigwAclPolicyV2
    func GetApigwAclPolicyV2(ctx *Context, name string, id IDInput, state *ApigwAclPolicyV2State, opts ...ResourceOption) (*ApigwAclPolicyV2, error)
    public static ApigwAclPolicyV2 Get(string name, Input<string> id, ApigwAclPolicyV2State? state, CustomResourceOptions? opts = null)
    public static ApigwAclPolicyV2 get(String name, Output<String> id, ApigwAclPolicyV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwAclPolicyV2    get:      id: ${id}
    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:
    ApigwAclPolicyV2Id string
    The ID of the ACL policy.
    EntityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    GatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    Name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    Region string
    The region where the ACL policy is located.
    Type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    UpdatedAt string
    The latest update time of the ACL policy.
    Value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    ApigwAclPolicyV2Id string
    The ID of the ACL policy.
    EntityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    GatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    Name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    Region string
    The region where the ACL policy is located.
    Type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    UpdatedAt string
    The latest update time of the ACL policy.
    Value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id String
    The ID of the ACL policy.
    entityType String
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId String
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    name String
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    region String
    The region where the ACL policy is located.
    type String
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    updatedAt String
    The latest update time of the ACL policy.
    value String
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id string
    The ID of the ACL policy.
    entityType string
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId string
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    name string
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    region string
    The region where the ACL policy is located.
    type string
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    updatedAt string
    The latest update time of the ACL policy.
    value string
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigw_acl_policy_v2_id str
    The ID of the ACL policy.
    entity_type str
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gateway_id str
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    name str
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    region str
    The region where the ACL policy is located.
    type str
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    updated_at str
    The latest update time of the ACL policy.
    value str
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).
    apigwAclPolicyV2Id String
    The ID of the ACL policy.
    entityType String
    Specifies the entity type of the ACL policy. The valid values are as follows:

    • IP: This rule is specified to control access to the API for specific IPs.
    • DOMAIN: This rule is specified to control access to the API for specific accounts (specified by domain name).
    • DOMAIN_ID: This rule is specified to control access to the API for specific accounts (specified by domain ID). Changing this will create a new resource.
    gatewayId String
    Specifies the ID of the dedicated gateway instance to which the ACL policy belongs. Changing this will create a new resource.
    name String
    Specifies the name of the ACL policy. The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an letter.
    region String
    The region where the ACL policy is located.
    type String
    Specifies the type of the ACL policy. The valid values are as follows:

    • PERMIT: Allow specific IPs or accounts to access API.
    • DENY: Forbid specific IPs or accounts to access API.
    updatedAt String
    The latest update time of the ACL policy.
    value String
    Specifies one or more objects from which the access will be controlled. Separate multiple objects with commas (,).

    Import

    ACL Policies can be imported using their id and related dedicated gateway ID, separated by a slash, e.g.

    bash

    $ pulumi import opentelekomcloud:index/apigwAclPolicyV2:ApigwAclPolicyV2 test <gateway_id>/<id>

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud