AccessPolicy

Provides a Cloudflare Access Policy resource. Access Policies are used in conjunction with Access Applications to restrict access to a particular resource.

Create a AccessPolicy Resource

new AccessPolicy(name: string, args: AccessPolicyArgs, opts?: CustomResourceOptions);

def AccessPolicy(resource_name, opts=None, application_id=None, decision=None, excludes=None, includes=None, name=None, precedence=None, requires=None, zone_id=None, __props__=None);

func NewAccessPolicy(ctx *Context, name string, args AccessPolicyArgs, opts ...ResourceOption) (*AccessPolicy, error)

public AccessPolicy(string name, AccessPolicyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AccessPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AccessPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccessPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

AccessPolicy Resource Properties

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

Inputs

The AccessPolicy resource accepts the following input properties:

ApplicationId string: The ID of the application the policy is associated with.
Decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
Includes List<AccessPolicyIncludeArgs>: A series of access conditions, see Access Groups.
Name string: Friendly name of the Access Application.
ZoneId string: The DNS zone to which the access rule should be added.
Excludes List<AccessPolicyExcludeArgs>: A series of access conditions, see Access Groups.
Precedence int: The unique precedence for policies on a single application. Integer.
Requires List<AccessPolicyRequireArgs>: A series of access conditions, see Access Groups.

ApplicationId string: The ID of the application the policy is associated with.
Decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
Includes []AccessPolicyInclude: A series of access conditions, see Access Groups.
Name string: Friendly name of the Access Application.
ZoneId string: The DNS zone to which the access rule should be added.
Excludes []AccessPolicyExclude: A series of access conditions, see Access Groups.
Precedence int: The unique precedence for policies on a single application. Integer.
Requires []AccessPolicyRequire: A series of access conditions, see Access Groups.

applicationId string: The ID of the application the policy is associated with.
decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
includes AccessPolicyInclude[]: A series of access conditions, see Access Groups.
name string: Friendly name of the Access Application.
zoneId string: The DNS zone to which the access rule should be added.
excludes AccessPolicyExclude[]: A series of access conditions, see Access Groups.
precedence number: The unique precedence for policies on a single application. Integer.
requires AccessPolicyRequire[]: A series of access conditions, see Access Groups.

application_id str: The ID of the application the policy is associated with.
decision str: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
includes List[AccessPolicyInclude]: A series of access conditions, see Access Groups.
name str: Friendly name of the Access Application.
zone_id str: The DNS zone to which the access rule should be added.
excludes List[AccessPolicyExclude]: A series of access conditions, see Access Groups.
precedence float: The unique precedence for policies on a single application. Integer.
requires List[AccessPolicyRequire]: A series of access conditions, see Access Groups.

Outputs

All input properties are implicitly available as output properties. Additionally, the AccessPolicy 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing AccessPolicy Resource

Get an existing AccessPolicy 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?: AccessPolicyState, opts?: CustomResourceOptions): AccessPolicy

static get(resource_name, id, opts=None, application_id=None, decision=None, excludes=None, includes=None, name=None, precedence=None, requires=None, zone_id=None, __props__=None);

func GetAccessPolicy(ctx *Context, name string, id IDInput, state *AccessPolicyState, opts ...ResourceOption) (*AccessPolicy, error)

public static AccessPolicy Get(string name, Input<string> id, AccessPolicyState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

ApplicationId string: The ID of the application the policy is associated with.
Decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
Excludes List<AccessPolicyExcludeArgs>: A series of access conditions, see Access Groups.
Includes List<AccessPolicyIncludeArgs>: A series of access conditions, see Access Groups.
Name string: Friendly name of the Access Application.
Precedence int: The unique precedence for policies on a single application. Integer.
Requires List<AccessPolicyRequireArgs>: A series of access conditions, see Access Groups.
ZoneId string: The DNS zone to which the access rule should be added.

ApplicationId string: The ID of the application the policy is associated with.
Decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
Excludes []AccessPolicyExclude: A series of access conditions, see Access Groups.
Includes []AccessPolicyInclude: A series of access conditions, see Access Groups.
Name string: Friendly name of the Access Application.
Precedence int: The unique precedence for policies on a single application. Integer.
Requires []AccessPolicyRequire: A series of access conditions, see Access Groups.
ZoneId string: The DNS zone to which the access rule should be added.

applicationId string: The ID of the application the policy is associated with.
decision string: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
excludes AccessPolicyExclude[]: A series of access conditions, see Access Groups.
includes AccessPolicyInclude[]: A series of access conditions, see Access Groups.
name string: Friendly name of the Access Application.
precedence number: The unique precedence for policies on a single application. Integer.
requires AccessPolicyRequire[]: A series of access conditions, see Access Groups.
zoneId string: The DNS zone to which the access rule should be added.

application_id str: The ID of the application the policy is associated with.
decision str: Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, non_identity, bypass
excludes List[AccessPolicyExclude]: A series of access conditions, see Access Groups.
includes List[AccessPolicyInclude]: A series of access conditions, see Access Groups.
name str: Friendly name of the Access Application.
precedence float: The unique precedence for policies on a single application. Integer.
requires List[AccessPolicyRequire]: A series of access conditions, see Access Groups.
zone_id str: The DNS zone to which the access rule should be added.