Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. GithubRepositoryFeed
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.GithubRepositoryFeed

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a GitHub repository feed in Octopus Deploy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = new octopusdeploy.GithubRepositoryFeed("example", {
    downloadAttempts: 1,
    downloadRetryBackoffSeconds: 30,
    feedUri: "https://api.github.com",
    password: "test-password",
    username: "test-username",
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.GithubRepositoryFeed("example",
    download_attempts=1,
    download_retry_backoff_seconds=30,
    feed_uri="https://api.github.com",
    password="test-password",
    username="test-username")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewGithubRepositoryFeed(ctx, "example", &octopusdeploy.GithubRepositoryFeedArgs{
			DownloadAttempts:            pulumi.Float64(1),
			DownloadRetryBackoffSeconds: pulumi.Float64(30),
			FeedUri:                     pulumi.String("https://api.github.com"),
			Password:                    pulumi.String("test-password"),
			Username:                    pulumi.String("test-username"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.GithubRepositoryFeed("example", new()
    {
        DownloadAttempts = 1,
        DownloadRetryBackoffSeconds = 30,
        FeedUri = "https://api.github.com",
        Password = "test-password",
        Username = "test-username",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.GithubRepositoryFeed;
import com.pulumi.octopusdeploy.GithubRepositoryFeedArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new GithubRepositoryFeed("example", GithubRepositoryFeedArgs.builder()
            .downloadAttempts(1)
            .downloadRetryBackoffSeconds(30)
            .feedUri("https://api.github.com")
            .password("test-password")
            .username("test-username")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:GithubRepositoryFeed
    properties:
      downloadAttempts: 1
      downloadRetryBackoffSeconds: 30
      feedUri: https://api.github.com
      password: test-password
      username: test-username

    Create GithubRepositoryFeed Resource

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

    Constructor syntax

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

@overload
def GithubRepositoryFeed(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         feed_uri: Optional[str] = None,
                         download_attempts: Optional[float] = None,
                         download_retry_backoff_seconds: Optional[float] = None,
                         name: Optional[str] = None,
                         package_acquisition_location_options: Optional[Sequence[str]] = None,
                         password: Optional[str] = None,
                         space_id: Optional[str] = None,
                         username: Optional[str] = None)
    func NewGithubRepositoryFeed(ctx *Context, name string, args GithubRepositoryFeedArgs, opts ...ResourceOption) (*GithubRepositoryFeed, error)
    public GithubRepositoryFeed(string name, GithubRepositoryFeedArgs args, CustomResourceOptions? opts = null)
    public GithubRepositoryFeed(String name, GithubRepositoryFeedArgs args)
public GithubRepositoryFeed(String name, GithubRepositoryFeedArgs args, CustomResourceOptions options)

    type: octopusdeploy:GithubRepositoryFeed
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 GithubRepositoryFeedArgs
    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 GithubRepositoryFeedArgs
    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 GithubRepositoryFeedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GithubRepositoryFeedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GithubRepositoryFeedArgs
    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 githubRepositoryFeedResource = new Octopusdeploy.GithubRepositoryFeed("githubRepositoryFeedResource", new()
{
    FeedUri = "string",
    DownloadAttempts = 0,
    DownloadRetryBackoffSeconds = 0,
    Name = "string",
    PackageAcquisitionLocationOptions = new[]
    {
        "string",
    },
    Password = "string",
    SpaceId = "string",
    Username = "string",
});

    example, err := octopusdeploy.NewGithubRepositoryFeed(ctx, "githubRepositoryFeedResource", &octopusdeploy.GithubRepositoryFeedArgs{
	FeedUri:                     pulumi.String("string"),
	DownloadAttempts:            pulumi.Float64(0),
	DownloadRetryBackoffSeconds: pulumi.Float64(0),
	Name:                        pulumi.String("string"),
	PackageAcquisitionLocationOptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Password: pulumi.String("string"),
	SpaceId:  pulumi.String("string"),
	Username: pulumi.String("string"),
})

    var githubRepositoryFeedResource = new GithubRepositoryFeed("githubRepositoryFeedResource", GithubRepositoryFeedArgs.builder()
    .feedUri("string")
    .downloadAttempts(0)
    .downloadRetryBackoffSeconds(0)
    .name("string")
    .packageAcquisitionLocationOptions("string")
    .password("string")
    .spaceId("string")
    .username("string")
    .build());

    github_repository_feed_resource = octopusdeploy.GithubRepositoryFeed("githubRepositoryFeedResource",
    feed_uri="string",
    download_attempts=0,
    download_retry_backoff_seconds=0,
    name="string",
    package_acquisition_location_options=["string"],
    password="string",
    space_id="string",
    username="string")

    const githubRepositoryFeedResource = new octopusdeploy.GithubRepositoryFeed("githubRepositoryFeedResource", {
    feedUri: "string",
    downloadAttempts: 0,
    downloadRetryBackoffSeconds: 0,
    name: "string",
    packageAcquisitionLocationOptions: ["string"],
    password: "string",
    spaceId: "string",
    username: "string",
});

    type: octopusdeploy:GithubRepositoryFeed
properties:
    downloadAttempts: 0
    downloadRetryBackoffSeconds: 0
    feedUri: string
    name: string
    packageAcquisitionLocationOptions:
        - string
    password: string
    spaceId: string
    username: string

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

    FeedUri string
    DownloadAttempts double
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds double
    The number of seconds to apply as a linear back off between download attempts.
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions List<string>
    Password string
    The password associated with this resource.
    SpaceId string
    The space ID associated with this github repository feed.
    Username string
    The username associated with this resource.
    FeedUri string
    DownloadAttempts float64
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds float64
    The number of seconds to apply as a linear back off between download attempts.
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions []string
    Password string
    The password associated with this resource.
    SpaceId string
    The space ID associated with this github repository feed.
    Username string
    The username associated with this resource.
    feedUri String
    downloadAttempts Double
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Double
    The number of seconds to apply as a linear back off between download attempts.
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    spaceId String
    The space ID associated with this github repository feed.
    username String
    The username associated with this resource.
    feedUri string
    downloadAttempts number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds number
    The number of seconds to apply as a linear back off between download attempts.
    name string
    The name of this resource.
    packageAcquisitionLocationOptions string[]
    password string
    The password associated with this resource.
    spaceId string
    The space ID associated with this github repository feed.
    username string
    The username associated with this resource.
    feed_uri str
    download_attempts float
    The number of times a deployment should attempt to download a package from this feed before failing.
    download_retry_backoff_seconds float
    The number of seconds to apply as a linear back off between download attempts.
    name str
    The name of this resource.
    package_acquisition_location_options Sequence[str]
    password str
    The password associated with this resource.
    space_id str
    The space ID associated with this github repository feed.
    username str
    The username associated with this resource.
    feedUri String
    downloadAttempts Number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Number
    The number of seconds to apply as a linear back off between download attempts.
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    spaceId String
    The space ID associated with this github repository feed.
    username String
    The username associated with this resource.

    Outputs

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

    Get an existing GithubRepositoryFeed 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?: GithubRepositoryFeedState, opts?: CustomResourceOptions): GithubRepositoryFeed
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        download_attempts: Optional[float] = None,
        download_retry_backoff_seconds: Optional[float] = None,
        feed_uri: Optional[str] = None,
        name: Optional[str] = None,
        package_acquisition_location_options: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        space_id: Optional[str] = None,
        username: Optional[str] = None) -> GithubRepositoryFeed
    func GetGithubRepositoryFeed(ctx *Context, name string, id IDInput, state *GithubRepositoryFeedState, opts ...ResourceOption) (*GithubRepositoryFeed, error)
    public static GithubRepositoryFeed Get(string name, Input<string> id, GithubRepositoryFeedState? state, CustomResourceOptions? opts = null)
    public static GithubRepositoryFeed get(String name, Output<String> id, GithubRepositoryFeedState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:GithubRepositoryFeed    get:      id: ${id}
    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:
    DownloadAttempts double
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds double
    The number of seconds to apply as a linear back off between download attempts.
    FeedUri string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions List<string>
    Password string
    The password associated with this resource.
    SpaceId string
    The space ID associated with this github repository feed.
    Username string
    The username associated with this resource.
    DownloadAttempts float64
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds float64
    The number of seconds to apply as a linear back off between download attempts.
    FeedUri string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions []string
    Password string
    The password associated with this resource.
    SpaceId string
    The space ID associated with this github repository feed.
    Username string
    The username associated with this resource.
    downloadAttempts Double
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Double
    The number of seconds to apply as a linear back off between download attempts.
    feedUri String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    spaceId String
    The space ID associated with this github repository feed.
    username String
    The username associated with this resource.
    downloadAttempts number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds number
    The number of seconds to apply as a linear back off between download attempts.
    feedUri string
    name string
    The name of this resource.
    packageAcquisitionLocationOptions string[]
    password string
    The password associated with this resource.
    spaceId string
    The space ID associated with this github repository feed.
    username string
    The username associated with this resource.
    download_attempts float
    The number of times a deployment should attempt to download a package from this feed before failing.
    download_retry_backoff_seconds float
    The number of seconds to apply as a linear back off between download attempts.
    feed_uri str
    name str
    The name of this resource.
    package_acquisition_location_options Sequence[str]
    password str
    The password associated with this resource.
    space_id str
    The space ID associated with this github repository feed.
    username str
    The username associated with this resource.
    downloadAttempts Number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Number
    The number of seconds to apply as a linear back off between download attempts.
    feedUri String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    spaceId String
    The space ID associated with this github repository feed.
    username String
    The username associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/githubRepositoryFeed:GithubRepositoryFeed [options] octopusdeploy_github_repository_feed.<name> <feed-id>

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

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy