Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Buildkite
  3. API Docs
  4. Provider
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

buildkite.Provider

Explore with Pulumi AI

buildkite logo
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

    The provider type for the buildkite package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_token: Optional[str] = None,
             archive_pipeline_on_delete: Optional[bool] = None,
             graphql_url: Optional[str] = None,
             organization: Optional[str] = None,
             rest_url: Optional[str] = None,
             timeouts: Optional[ProviderTimeoutsArgs] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:buildkite
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiToken string
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    ArchivePipelineOnDelete bool
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    GraphqlUrl string
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    Organization string
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    RestUrl string
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    Timeouts Pulumiverse.Buildkite.Inputs.ProviderTimeouts
    ApiToken string
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    ArchivePipelineOnDelete bool
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    GraphqlUrl string
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    Organization string
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    RestUrl string
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    Timeouts ProviderTimeoutsArgs
    apiToken String
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    archivePipelineOnDelete Boolean
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    graphqlUrl String
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    organization String
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    restUrl String
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    timeouts ProviderTimeouts
    apiToken string
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    archivePipelineOnDelete boolean
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    graphqlUrl string
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    organization string
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    restUrl string
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    timeouts ProviderTimeouts
    api_token str
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    archive_pipeline_on_delete bool
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    graphql_url str
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    organization str
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    rest_url str
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    timeouts ProviderTimeoutsArgs
    apiToken String
    API token with GraphQL access and write_pipelines, read_pipelines and write_suites REST API scopes. You can generate a token from your settings page. If not provided, the value is taken from the BUILDKITE_API_TOKEN environment variable.
    archivePipelineOnDelete Boolean
    Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines.
    graphqlUrl String
    Base URL for the GraphQL API to use. If not provided, the value is taken from the BUILDKITE_GRAPHQL_URL environment variable.
    organization String
    The Buildkite organization slug. This can be found on the settings page. If not provided, the value is taken from the BUILDKITE_ORGANIZATION_SLUG environment variable.
    restUrl String
    Base URL for the REST API to use. If not provided, the value is taken from the BUILDKITE_REST_URL environment variable.
    timeouts Property Map

    Outputs

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

    Supporting Types

    ProviderTimeouts, ProviderTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
    pulumiverse/pulumi-buildkite