1. Packages
  2. GitHub
  3. API Docs
  4. AppInstallationRepositories
GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi

github.AppInstallationRepositories

Explore with Pulumi AI

github logo
GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi

    Note: This resource is not compatible with the GitHub App Installation authentication method.

    This resource manages relationships between app installations and repositories in your GitHub organization.

    Creating this resource installs a particular app on multiple repositories.

    The app installation and the repositories must all belong to the same organization on GitHub. Note: you can review your organization’s installations by the following the instructions at this link.

    Create AppInstallationRepositories Resource

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

    Constructor syntax

    new AppInstallationRepositories(name: string, args: AppInstallationRepositoriesArgs, opts?: CustomResourceOptions);
    @overload
    def AppInstallationRepositories(resource_name: str,
                                    args: AppInstallationRepositoriesArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppInstallationRepositories(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    installation_id: Optional[str] = None,
                                    selected_repositories: Optional[Sequence[str]] = None)
    func NewAppInstallationRepositories(ctx *Context, name string, args AppInstallationRepositoriesArgs, opts ...ResourceOption) (*AppInstallationRepositories, error)
    public AppInstallationRepositories(string name, AppInstallationRepositoriesArgs args, CustomResourceOptions? opts = null)
    public AppInstallationRepositories(String name, AppInstallationRepositoriesArgs args)
    public AppInstallationRepositories(String name, AppInstallationRepositoriesArgs args, CustomResourceOptions options)
    
    type: github:AppInstallationRepositories
    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 AppInstallationRepositoriesArgs
    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 AppInstallationRepositoriesArgs
    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 AppInstallationRepositoriesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppInstallationRepositoriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppInstallationRepositoriesArgs
    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 appInstallationRepositoriesResource = new Github.AppInstallationRepositories("appInstallationRepositoriesResource", new()
    {
        InstallationId = "string",
        SelectedRepositories = new[]
        {
            "string",
        },
    });
    
    example, err := github.NewAppInstallationRepositories(ctx, "appInstallationRepositoriesResource", &github.AppInstallationRepositoriesArgs{
    	InstallationId: pulumi.String("string"),
    	SelectedRepositories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var appInstallationRepositoriesResource = new AppInstallationRepositories("appInstallationRepositoriesResource", AppInstallationRepositoriesArgs.builder()
        .installationId("string")
        .selectedRepositories("string")
        .build());
    
    app_installation_repositories_resource = github.AppInstallationRepositories("appInstallationRepositoriesResource",
        installation_id="string",
        selected_repositories=["string"])
    
    const appInstallationRepositoriesResource = new github.AppInstallationRepositories("appInstallationRepositoriesResource", {
        installationId: "string",
        selectedRepositories: ["string"],
    });
    
    type: github:AppInstallationRepositories
    properties:
        installationId: string
        selectedRepositories:
            - string
    

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

    InstallationId string
    The GitHub app installation id.
    SelectedRepositories List<string>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    InstallationId string
    The GitHub app installation id.
    SelectedRepositories []string

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId String
    The GitHub app installation id.
    selectedRepositories List<String>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId string
    The GitHub app installation id.
    selectedRepositories string[]

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installation_id str
    The GitHub app installation id.
    selected_repositories Sequence[str]

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId String
    The GitHub app installation id.
    selectedRepositories List<String>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    Outputs

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

    Get an existing AppInstallationRepositories 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?: AppInstallationRepositoriesState, opts?: CustomResourceOptions): AppInstallationRepositories
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            installation_id: Optional[str] = None,
            selected_repositories: Optional[Sequence[str]] = None) -> AppInstallationRepositories
    func GetAppInstallationRepositories(ctx *Context, name string, id IDInput, state *AppInstallationRepositoriesState, opts ...ResourceOption) (*AppInstallationRepositories, error)
    public static AppInstallationRepositories Get(string name, Input<string> id, AppInstallationRepositoriesState? state, CustomResourceOptions? opts = null)
    public static AppInstallationRepositories get(String name, Output<String> id, AppInstallationRepositoriesState 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:
    InstallationId string
    The GitHub app installation id.
    SelectedRepositories List<string>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    InstallationId string
    The GitHub app installation id.
    SelectedRepositories []string

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId String
    The GitHub app installation id.
    selectedRepositories List<String>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId string
    The GitHub app installation id.
    selectedRepositories string[]

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installation_id str
    The GitHub app installation id.
    selected_repositories Sequence[str]

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    installationId String
    The GitHub app installation id.
    selectedRepositories List<String>

    A list of repository names to install the app on.

    Note: Due to how GitHub implements app installations, apps cannot be installed with no repositories selected. Therefore deleting this resource will leave one repository with the app installed. Manually uninstall the app or set the installation to all repositories via the GUI as after deleting this resource.

    Import

    GitHub App Installation Repositories can be imported using an ID made up of installation_id, e.g.

    $ pulumi import github:index/appInstallationRepositories:AppInstallationRepositories some_app_repos 1234567
    

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

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi