1. Packages
  2. Cloudflare
  3. API Docs
  4. AccessTag
Cloudflare v5.25.0 published on Sunday, Apr 7, 2024 by Pulumi

cloudflare.AccessTag

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.25.0 published on Sunday, Apr 7, 2024 by Pulumi

    Provides a resource to customize the pages your end users will see when trying to reach applications behind Cloudflare Access.

    Create AccessTag Resource

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

    Constructor syntax

    new AccessTag(name: string, args: AccessTagArgs, opts?: CustomResourceOptions);
    @overload
    def AccessTag(resource_name: str,
                  args: AccessTagArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessTag(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  account_id: Optional[str] = None,
                  app_count: Optional[int] = None,
                  zone_id: Optional[str] = None)
    func NewAccessTag(ctx *Context, name string, args AccessTagArgs, opts ...ResourceOption) (*AccessTag, error)
    public AccessTag(string name, AccessTagArgs args, CustomResourceOptions? opts = null)
    public AccessTag(String name, AccessTagArgs args)
    public AccessTag(String name, AccessTagArgs args, CustomResourceOptions options)
    
    type: cloudflare:AccessTag
    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 AccessTagArgs
    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 AccessTagArgs
    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 AccessTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessTagArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var accessTagResource = new Cloudflare.AccessTag("accessTagResource", new()
    {
        Name = "string",
        AccountId = "string",
        AppCount = 0,
        ZoneId = "string",
    });
    
    example, err := cloudflare.NewAccessTag(ctx, "accessTagResource", &cloudflare.AccessTagArgs{
    	Name:      pulumi.String("string"),
    	AccountId: pulumi.String("string"),
    	AppCount:  pulumi.Int(0),
    	ZoneId:    pulumi.String("string"),
    })
    
    var accessTagResource = new AccessTag("accessTagResource", AccessTagArgs.builder()        
        .name("string")
        .accountId("string")
        .appCount(0)
        .zoneId("string")
        .build());
    
    access_tag_resource = cloudflare.AccessTag("accessTagResource",
        name="string",
        account_id="string",
        app_count=0,
        zone_id="string")
    
    const accessTagResource = new cloudflare.AccessTag("accessTagResource", {
        name: "string",
        accountId: "string",
        appCount: 0,
        zoneId: "string",
    });
    
    type: cloudflare:AccessTag
    properties:
        accountId: string
        appCount: 0
        name: string
        zoneId: string
    

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

    Name string
    Friendly name of the Access Tag.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    AppCount int
    Number of apps associated with the tag.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    Name string
    Friendly name of the Access Tag.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    AppCount int
    Number of apps associated with the tag.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name String
    Friendly name of the Access Tag.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount Integer
    Number of apps associated with the tag.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name string
    Friendly name of the Access Tag.
    accountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount number
    Number of apps associated with the tag.
    zoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name str
    Friendly name of the Access Tag.
    account_id str
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    app_count int
    Number of apps associated with the tag.
    zone_id str
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name String
    Friendly name of the Access Tag.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount Number
    Number of apps associated with the tag.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccessTag 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 AccessTag Resource

    Get an existing AccessTag 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?: AccessTagState, opts?: CustomResourceOptions): AccessTag
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            app_count: Optional[int] = None,
            name: Optional[str] = None,
            zone_id: Optional[str] = None) -> AccessTag
    func GetAccessTag(ctx *Context, name string, id IDInput, state *AccessTagState, opts ...ResourceOption) (*AccessTag, error)
    public static AccessTag Get(string name, Input<string> id, AccessTagState? state, CustomResourceOptions? opts = null)
    public static AccessTag get(String name, Output<String> id, AccessTagState 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:
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    AppCount int
    Number of apps associated with the tag.
    Name string
    Friendly name of the Access Tag.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    AppCount int
    Number of apps associated with the tag.
    Name string
    Friendly name of the Access Tag.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount Integer
    Number of apps associated with the tag.
    name String
    Friendly name of the Access Tag.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId string
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount number
    Number of apps associated with the tag.
    name string
    Friendly name of the Access Tag.
    zoneId string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    account_id str
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    app_count int
    Number of apps associated with the tag.
    name str
    Friendly name of the Access Tag.
    zone_id str
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
    appCount Number
    Number of apps associated with the tag.
    name String
    Friendly name of the Access Tag.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.25.0 published on Sunday, Apr 7, 2024 by Pulumi