Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Doppler
  3. API Docs
  4. secretsSync
  5. GithubActions
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

doppler.secretsSync.GithubActions

Explore with Pulumi AI

doppler logo
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

    Manage a GitHub Actions Doppler sync.

    Create GithubActions Resource

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

    Constructor syntax

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

@overload
def GithubActions(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  config: Optional[str] = None,
                  integration: Optional[str] = None,
                  project: Optional[str] = None,
                  sync_target: Optional[str] = None,
                  delete_behavior: Optional[str] = None,
                  environment_name: Optional[str] = None,
                  org_scope: Optional[str] = None,
                  repo_name: Optional[str] = None)
    func NewGithubActions(ctx *Context, name string, args GithubActionsArgs, opts ...ResourceOption) (*GithubActions, error)
    public GithubActions(string name, GithubActionsArgs args, CustomResourceOptions? opts = null)
    public GithubActions(String name, GithubActionsArgs args)
public GithubActions(String name, GithubActionsArgs args, CustomResourceOptions options)

    type: doppler:secretsSync:GithubActions
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 GithubActionsArgs
    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 GithubActionsArgs
    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 GithubActionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GithubActionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GithubActionsArgs
    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 githubActionsResource = new Doppler.SecretsSync.GithubActions("githubActionsResource", new()
{
    Config = "string",
    Integration = "string",
    Project = "string",
    SyncTarget = "string",
    DeleteBehavior = "string",
    EnvironmentName = "string",
    OrgScope = "string",
    RepoName = "string",
});

    example, err := secretsSync.NewGithubActions(ctx, "githubActionsResource", &secretsSync.GithubActionsArgs{
	Config:          pulumi.String("string"),
	Integration:     pulumi.String("string"),
	Project:         pulumi.String("string"),
	SyncTarget:      pulumi.String("string"),
	DeleteBehavior:  pulumi.String("string"),
	EnvironmentName: pulumi.String("string"),
	OrgScope:        pulumi.String("string"),
	RepoName:        pulumi.String("string"),
})

    var githubActionsResource = new GithubActions("githubActionsResource", GithubActionsArgs.builder()
    .config("string")
    .integration("string")
    .project("string")
    .syncTarget("string")
    .deleteBehavior("string")
    .environmentName("string")
    .orgScope("string")
    .repoName("string")
    .build());

    github_actions_resource = doppler.secrets_sync.GithubActions("githubActionsResource",
    config="string",
    integration="string",
    project="string",
    sync_target="string",
    delete_behavior="string",
    environment_name="string",
    org_scope="string",
    repo_name="string")

    const githubActionsResource = new doppler.secretssync.GithubActions("githubActionsResource", {
    config: "string",
    integration: "string",
    project: "string",
    syncTarget: "string",
    deleteBehavior: "string",
    environmentName: "string",
    orgScope: "string",
    repoName: "string",
});

    type: doppler:secretsSync:GithubActions
properties:
    config: string
    deleteBehavior: string
    environmentName: string
    integration: string
    orgScope: string
    project: string
    repoName: string
    syncTarget: string

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

    Config string
    The name of the Doppler config
    Integration string
    The slug of the integration to use for this sync
    Project string
    The name of the Doppler project
    SyncTarget string
    Either "repo" or "org", based on the resource type to sync to
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    EnvironmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    OrgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    RepoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    Config string
    The name of the Doppler config
    Integration string
    The slug of the integration to use for this sync
    Project string
    The name of the Doppler project
    SyncTarget string
    Either "repo" or "org", based on the resource type to sync to
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    EnvironmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    OrgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    RepoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    config String
    The name of the Doppler config
    integration String
    The slug of the integration to use for this sync
    project String
    The name of the Doppler project
    syncTarget String
    Either "repo" or "org", based on the resource type to sync to
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName String
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    orgScope String
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    repoName String
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    config string
    The name of the Doppler config
    integration string
    The slug of the integration to use for this sync
    project string
    The name of the Doppler project
    syncTarget string
    Either "repo" or "org", based on the resource type to sync to
    deleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    orgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    repoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    config str
    The name of the Doppler config
    integration str
    The slug of the integration to use for this sync
    project str
    The name of the Doppler project
    sync_target str
    Either "repo" or "org", based on the resource type to sync to
    delete_behavior str
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environment_name str
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    org_scope str
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    repo_name str
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    config String
    The name of the Doppler config
    integration String
    The slug of the integration to use for this sync
    project String
    The name of the Doppler project
    syncTarget String
    Either "repo" or "org", based on the resource type to sync to
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName String
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    orgScope String
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    repoName String
    The GitHub repo name to sync to (only used when sync_target is set to "repo")

    Outputs

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

    Get an existing GithubActions 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?: GithubActionsState, opts?: CustomResourceOptions): GithubActions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        delete_behavior: Optional[str] = None,
        environment_name: Optional[str] = None,
        integration: Optional[str] = None,
        org_scope: Optional[str] = None,
        project: Optional[str] = None,
        repo_name: Optional[str] = None,
        sync_target: Optional[str] = None) -> GithubActions
    func GetGithubActions(ctx *Context, name string, id IDInput, state *GithubActionsState, opts ...ResourceOption) (*GithubActions, error)
    public static GithubActions Get(string name, Input<string> id, GithubActionsState? state, CustomResourceOptions? opts = null)
    public static GithubActions get(String name, Output<String> id, GithubActionsState 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:
    Config string
    The name of the Doppler config
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    EnvironmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    Integration string
    The slug of the integration to use for this sync
    OrgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    Project string
    The name of the Doppler project
    RepoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    SyncTarget string
    Either "repo" or "org", based on the resource type to sync to
    Config string
    The name of the Doppler config
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    EnvironmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    Integration string
    The slug of the integration to use for this sync
    OrgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    Project string
    The name of the Doppler project
    RepoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    SyncTarget string
    Either "repo" or "org", based on the resource type to sync to
    config String
    The name of the Doppler config
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName String
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    integration String
    The slug of the integration to use for this sync
    orgScope String
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    project String
    The name of the Doppler project
    repoName String
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    syncTarget String
    Either "repo" or "org", based on the resource type to sync to
    config string
    The name of the Doppler config
    deleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName string
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    integration string
    The slug of the integration to use for this sync
    orgScope string
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    project string
    The name of the Doppler project
    repoName string
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    syncTarget string
    Either "repo" or "org", based on the resource type to sync to
    config str
    The name of the Doppler config
    delete_behavior str
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environment_name str
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    integration str
    The slug of the integration to use for this sync
    org_scope str
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    project str
    The name of the Doppler project
    repo_name str
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    sync_target str
    Either "repo" or "org", based on the resource type to sync to
    config String
    The name of the Doppler config
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    environmentName String
    The GitHub repo environment name to sync to (only used when sync_target is set to "repo")
    integration String
    The slug of the integration to use for this sync
    orgScope String
    Either "all" or "private", based on the which repos you want to have access (only used when sync_target is set to "org")
    project String
    The name of the Doppler project
    repoName String
    The GitHub repo name to sync to (only used when sync_target is set to "repo")
    syncTarget String
    Either "repo" or "org", based on the resource type to sync to

    Package Details

    Repository
    doppler pulumiverse/pulumi-doppler
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the doppler Terraform Provider.
    doppler logo
    Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
    pulumiverse/pulumi-doppler