1. Packages
  2. Cloudflare
  3. API Docs
  4. AccessServiceToken
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.AccessServiceToken

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    Access Service Tokens are used for service-to-service communication when an application is behind Cloudflare Access.

    Create AccessServiceToken Resource

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

    Constructor syntax

    new AccessServiceToken(name: string, args: AccessServiceTokenArgs, opts?: CustomResourceOptions);
    @overload
    def AccessServiceToken(resource_name: str,
                           args: AccessServiceTokenArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessServiceToken(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           name: Optional[str] = None,
                           account_id: Optional[str] = None,
                           duration: Optional[str] = None,
                           min_days_for_renewal: Optional[int] = None,
                           zone_id: Optional[str] = None)
    func NewAccessServiceToken(ctx *Context, name string, args AccessServiceTokenArgs, opts ...ResourceOption) (*AccessServiceToken, error)
    public AccessServiceToken(string name, AccessServiceTokenArgs args, CustomResourceOptions? opts = null)
    public AccessServiceToken(String name, AccessServiceTokenArgs args)
    public AccessServiceToken(String name, AccessServiceTokenArgs args, CustomResourceOptions options)
    
    type: cloudflare:AccessServiceToken
    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 AccessServiceTokenArgs
    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 AccessServiceTokenArgs
    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 AccessServiceTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessServiceTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessServiceTokenArgs
    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 accessServiceTokenResource = new Cloudflare.AccessServiceToken("accessServiceTokenResource", new()
    {
        Name = "string",
        AccountId = "string",
        Duration = "string",
        MinDaysForRenewal = 0,
        ZoneId = "string",
    });
    
    example, err := cloudflare.NewAccessServiceToken(ctx, "accessServiceTokenResource", &cloudflare.AccessServiceTokenArgs{
    	Name:              pulumi.String("string"),
    	AccountId:         pulumi.String("string"),
    	Duration:          pulumi.String("string"),
    	MinDaysForRenewal: pulumi.Int(0),
    	ZoneId:            pulumi.String("string"),
    })
    
    var accessServiceTokenResource = new AccessServiceToken("accessServiceTokenResource", AccessServiceTokenArgs.builder()
        .name("string")
        .accountId("string")
        .duration("string")
        .minDaysForRenewal(0)
        .zoneId("string")
        .build());
    
    access_service_token_resource = cloudflare.AccessServiceToken("accessServiceTokenResource",
        name="string",
        account_id="string",
        duration="string",
        min_days_for_renewal=0,
        zone_id="string")
    
    const accessServiceTokenResource = new cloudflare.AccessServiceToken("accessServiceTokenResource", {
        name: "string",
        accountId: "string",
        duration: "string",
        minDaysForRenewal: 0,
        zoneId: "string",
    });
    
    type: cloudflare:AccessServiceToken
    properties:
        accountId: string
        duration: string
        minDaysForRenewal: 0
        name: string
        zoneId: string
    

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

    Name string
    Friendly name of the token's intent.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id.
    Duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    MinDaysForRenewal int
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    Name string
    Friendly name of the token's intent.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id.
    Duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    MinDaysForRenewal int
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    name String
    Friendly name of the token's intent.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id.
    duration String
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    minDaysForRenewal Integer
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id.
    name string
    Friendly name of the token's intent.
    accountId string
    The account identifier to target for the resource. Conflicts with zone_id.
    duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    minDaysForRenewal number
    zoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    name str
    Friendly name of the token's intent.
    account_id str
    The account identifier to target for the resource. Conflicts with zone_id.
    duration str
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    min_days_for_renewal int
    zone_id str
    The zone identifier to target for the resource. Conflicts with account_id.
    name String
    Friendly name of the token's intent.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id.
    duration String
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    minDaysForRenewal Number
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id.

    Outputs

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

    ClientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    ClientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    ExpiresAt string
    Date when the token expires.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    ClientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    ExpiresAt string
    Date when the token expires.
    Id string
    The provider-assigned unique ID for this managed resource.
    clientId String
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret String
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    expiresAt String
    Date when the token expires.
    id String
    The provider-assigned unique ID for this managed resource.
    clientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    expiresAt string
    Date when the token expires.
    id string
    The provider-assigned unique ID for this managed resource.
    client_id str
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    client_secret str
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    expires_at str
    Date when the token expires.
    id str
    The provider-assigned unique ID for this managed resource.
    clientId String
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret String
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    expiresAt String
    Date when the token expires.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AccessServiceToken Resource

    Get an existing AccessServiceToken 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?: AccessServiceTokenState, opts?: CustomResourceOptions): AccessServiceToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            duration: Optional[str] = None,
            expires_at: Optional[str] = None,
            min_days_for_renewal: Optional[int] = None,
            name: Optional[str] = None,
            zone_id: Optional[str] = None) -> AccessServiceToken
    func GetAccessServiceToken(ctx *Context, name string, id IDInput, state *AccessServiceTokenState, opts ...ResourceOption) (*AccessServiceToken, error)
    public static AccessServiceToken Get(string name, Input<string> id, AccessServiceTokenState? state, CustomResourceOptions? opts = null)
    public static AccessServiceToken get(String name, Output<String> id, AccessServiceTokenState 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.
    ClientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    ClientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    Duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    ExpiresAt string
    Date when the token expires.
    MinDaysForRenewal int
    Name string
    Friendly name of the token's intent.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    AccountId string
    The account identifier to target for the resource. Conflicts with zone_id.
    ClientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    ClientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    Duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    ExpiresAt string
    Date when the token expires.
    MinDaysForRenewal int
    Name string
    Friendly name of the token's intent.
    ZoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id.
    clientId String
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret String
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    duration String
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    expiresAt String
    Date when the token expires.
    minDaysForRenewal Integer
    name String
    Friendly name of the token's intent.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id.
    accountId string
    The account identifier to target for the resource. Conflicts with zone_id.
    clientId string
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret string
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    duration string
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    expiresAt string
    Date when the token expires.
    minDaysForRenewal number
    name string
    Friendly name of the token's intent.
    zoneId string
    The zone identifier to target for the resource. Conflicts with account_id.
    account_id str
    The account identifier to target for the resource. Conflicts with zone_id.
    client_id str
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    client_secret str
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    duration str
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    expires_at str
    Date when the token expires.
    min_days_for_renewal int
    name str
    Friendly name of the token's intent.
    zone_id str
    The zone identifier to target for the resource. Conflicts with account_id.
    accountId String
    The account identifier to target for the resource. Conflicts with zone_id.
    clientId String
    Client ID associated with the Service Token. Modifying this attribute will force creation of a new resource.
    clientSecret String
    A secret for interacting with Access protocols. Modifying this attribute will force creation of a new resource.
    duration String
    Length of time the service token is valid for. Available values: 8760h, 17520h, 43800h, 87600h, forever.
    expiresAt String
    Date when the token expires.
    minDaysForRenewal Number
    name String
    Friendly name of the token's intent.
    zoneId String
    The zone identifier to target for the resource. Conflicts with account_id.

    Import

    If you are importing an Access Service Token you will not have the

    client_secret available in the state for use. The client_secret is only

    available once, at creation. In most cases, it is better to just create a new

    resource should you need to reference it in other resources.

    $ pulumi import cloudflare:index/accessServiceToken:AccessServiceToken example <account_id>/<service_token_id>
    

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

    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.34.0 published on Friday, Jul 12, 2024 by Pulumi