1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. OrgAccessToken
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi

pulumiservice.OrgAccessToken

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi

    The Pulumi Cloud allows users to create access tokens scoped to orgs. Org access tokens is a resource to create them and assign them to an org

    Create OrgAccessToken Resource

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

    Constructor syntax

    new OrgAccessToken(name: string, args: OrgAccessTokenArgs, opts?: CustomResourceOptions);
    @overload
    def OrgAccessToken(resource_name: str,
                       args: OrgAccessTokenArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrgAccessToken(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       organization_name: Optional[str] = None,
                       admin: Optional[bool] = None,
                       description: Optional[str] = None)
    func NewOrgAccessToken(ctx *Context, name string, args OrgAccessTokenArgs, opts ...ResourceOption) (*OrgAccessToken, error)
    public OrgAccessToken(string name, OrgAccessTokenArgs args, CustomResourceOptions? opts = null)
    public OrgAccessToken(String name, OrgAccessTokenArgs args)
    public OrgAccessToken(String name, OrgAccessTokenArgs args, CustomResourceOptions options)
    
    type: pulumiservice:OrgAccessToken
    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 OrgAccessTokenArgs
    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 OrgAccessTokenArgs
    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 OrgAccessTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgAccessTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgAccessTokenArgs
    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 orgAccessTokenResource = new PulumiService.OrgAccessToken("orgAccessTokenResource", new()
    {
        Name = "string",
        OrganizationName = "string",
        Admin = false,
        Description = "string",
    });
    
    example, err := pulumiservice.NewOrgAccessToken(ctx, "orgAccessTokenResource", &pulumiservice.OrgAccessTokenArgs{
    	Name:             pulumi.String("string"),
    	OrganizationName: pulumi.String("string"),
    	Admin:            pulumi.Bool(false),
    	Description:      pulumi.String("string"),
    })
    
    var orgAccessTokenResource = new OrgAccessToken("orgAccessTokenResource", OrgAccessTokenArgs.builder()
        .name("string")
        .organizationName("string")
        .admin(false)
        .description("string")
        .build());
    
    org_access_token_resource = pulumiservice.OrgAccessToken("orgAccessTokenResource",
        name="string",
        organization_name="string",
        admin=False,
        description="string")
    
    const orgAccessTokenResource = new pulumiservice.OrgAccessToken("orgAccessTokenResource", {
        name: "string",
        organizationName: "string",
        admin: false,
        description: "string",
    });
    
    type: pulumiservice:OrgAccessToken
    properties:
        admin: false
        description: string
        name: string
        organizationName: string
    

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

    Name string
    The name for the token.
    OrganizationName string
    The organization's name.
    Admin bool
    Optional. True if this is an admin token.
    Description string
    Optional. Team description.
    Name string
    The name for the token.
    OrganizationName string
    The organization's name.
    Admin bool
    Optional. True if this is an admin token.
    Description string
    Optional. Team description.
    name String
    The name for the token.
    organizationName String
    The organization's name.
    admin Boolean
    Optional. True if this is an admin token.
    description String
    Optional. Team description.
    name string
    The name for the token.
    organizationName string
    The organization's name.
    admin boolean
    Optional. True if this is an admin token.
    description string
    Optional. Team description.
    name str
    The name for the token.
    organization_name str
    The organization's name.
    admin bool
    Optional. True if this is an admin token.
    description str
    Optional. Team description.
    name String
    The name for the token.
    organizationName String
    The organization's name.
    admin Boolean
    Optional. True if this is an admin token.
    description String
    Optional. Team description.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Value string
    The token's value.
    Id string
    The provider-assigned unique ID for this managed resource.
    Value string
    The token's value.
    id String
    The provider-assigned unique ID for this managed resource.
    value String
    The token's value.
    id string
    The provider-assigned unique ID for this managed resource.
    value string
    The token's value.
    id str
    The provider-assigned unique ID for this managed resource.
    value str
    The token's value.
    id String
    The provider-assigned unique ID for this managed resource.
    value String
    The token's value.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi