Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigAclPolicy
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigAclPolicy

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an ACL policy resource within FlexibleEngine.

    Example Usage

    Create ApigAclPolicy Resource

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

    Constructor syntax

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

@overload
def ApigAclPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  entity_type: Optional[str] = None,
                  instance_id: Optional[str] = None,
                  type: Optional[str] = None,
                  value: Optional[str] = None,
                  apig_acl_policy_id: Optional[str] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None)
    func NewApigAclPolicy(ctx *Context, name string, args ApigAclPolicyArgs, opts ...ResourceOption) (*ApigAclPolicy, error)
    public ApigAclPolicy(string name, ApigAclPolicyArgs args, CustomResourceOptions? opts = null)
    public ApigAclPolicy(String name, ApigAclPolicyArgs args)
public ApigAclPolicy(String name, ApigAclPolicyArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigAclPolicy
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 ApigAclPolicyArgs
    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 ApigAclPolicyArgs
    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 ApigAclPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigAclPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigAclPolicyArgs
    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 apigAclPolicyResource = new Flexibleengine.ApigAclPolicy("apigAclPolicyResource", new()
{
    EntityType = "string",
    InstanceId = "string",
    Type = "string",
    Value = "string",
    ApigAclPolicyId = "string",
    Name = "string",
    Region = "string",
});

    example, err := flexibleengine.NewApigAclPolicy(ctx, "apigAclPolicyResource", &flexibleengine.ApigAclPolicyArgs{
	EntityType:      pulumi.String("string"),
	InstanceId:      pulumi.String("string"),
	Type:            pulumi.String("string"),
	Value:           pulumi.String("string"),
	ApigAclPolicyId: pulumi.String("string"),
	Name:            pulumi.String("string"),
	Region:          pulumi.String("string"),
})

    var apigAclPolicyResource = new ApigAclPolicy("apigAclPolicyResource", ApigAclPolicyArgs.builder()
    .entityType("string")
    .instanceId("string")
    .type("string")
    .value("string")
    .apigAclPolicyId("string")
    .name("string")
    .region("string")
    .build());

    apig_acl_policy_resource = flexibleengine.ApigAclPolicy("apigAclPolicyResource",
    entity_type="string",
    instance_id="string",
    type="string",
    value="string",
    apig_acl_policy_id="string",
    name="string",
    region="string")

    const apigAclPolicyResource = new flexibleengine.ApigAclPolicy("apigAclPolicyResource", {
    entityType: "string",
    instanceId: "string",
    type: "string",
    value: "string",
    apigAclPolicyId: "string",
    name: "string",
    region: "string",
});

    type: flexibleengine:ApigAclPolicy
properties:
    apigAclPolicyId: string
    entityType: string
    instanceId: string
    name: string
    region: string
    type: string
    value: string

    ApigAclPolicy 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 ApigAclPolicy 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).

    Changing this will create a new resource.

    InstanceId string
    Specifies the ID of the dedicated 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 (,).
    ApigAclPolicyId 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 English letter or Chinese character.
    Region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    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).

    Changing this will create a new resource.

    InstanceId string
    Specifies the ID of the dedicated 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 (,).
    ApigAclPolicyId 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 English letter or Chinese character.
    Region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    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).

    Changing this will create a new resource.

    instanceId String
    Specifies the ID of the dedicated 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 (,).
    apigAclPolicyId 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 English letter or Chinese character.
    region String
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    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).

    Changing this will create a new resource.

    instanceId string
    Specifies the ID of the dedicated 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 (,).
    apigAclPolicyId 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 English letter or Chinese character.
    region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    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).

    Changing this will create a new resource.

    instance_id str
    Specifies the ID of the dedicated 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 (,).
    apig_acl_policy_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 English letter or Chinese character.
    region str
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    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).

    Changing this will create a new resource.

    instanceId String
    Specifies the ID of the dedicated 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 (,).
    apigAclPolicyId 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 English letter or Chinese character.
    region String
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.

    Outputs

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

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

    Look up Existing ApigAclPolicy Resource

    Get an existing ApigAclPolicy 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?: ApigAclPolicyState, opts?: CustomResourceOptions): ApigAclPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_acl_policy_id: Optional[str] = None,
        entity_type: Optional[str] = None,
        instance_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) -> ApigAclPolicy
    func GetApigAclPolicy(ctx *Context, name string, id IDInput, state *ApigAclPolicyState, opts ...ResourceOption) (*ApigAclPolicy, error)
    public static ApigAclPolicy Get(string name, Input<string> id, ApigAclPolicyState? state, CustomResourceOptions? opts = null)
    public static ApigAclPolicy get(String name, Output<String> id, ApigAclPolicyState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigAclPolicy    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:
    ApigAclPolicyId 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).

    Changing this will create a new resource.

    InstanceId string
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    Region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 (,).
    ApigAclPolicyId 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).

    Changing this will create a new resource.

    InstanceId string
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    Region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 (,).
    apigAclPolicyId 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).

    Changing this will create a new resource.

    instanceId String
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    region String
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 (,).
    apigAclPolicyId 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).

    Changing this will create a new resource.

    instanceId string
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    region string
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 (,).
    apig_acl_policy_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).

    Changing this will create a new resource.

    instance_id str
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    region str
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 (,).
    apigAclPolicyId 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).

    Changing this will create a new resource.

    instanceId String
    Specifies the ID of the dedicated 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 English letter or Chinese character.
    region String
    Specifies the region where the ACL policy is located.
    If omitted, the provider-level region will be used. 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.
    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 instance ID, separated by a slash, e.g.

    bash

    $ pulumi import flexibleengine:index/apigAclPolicy:ApigAclPolicy test <instance_id>/<id>

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine