Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. S3Feed
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.S3Feed

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a Amazon S3 Bucket feed in Octopus Deploy.

    Example Usage

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

const example = new octopusdeploy.S3Feed("example", {
    accessKey: "given_access_key",
    secretKey: "some_secret_key",
    useMachineCredentials: false,
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.S3Feed("example",
    access_key="given_access_key",
    secret_key="some_secret_key",
    use_machine_credentials=False)

    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.NewS3Feed(ctx, "example", &octopusdeploy.S3FeedArgs{
			AccessKey:             pulumi.String("given_access_key"),
			SecretKey:             pulumi.String("some_secret_key"),
			UseMachineCredentials: pulumi.Bool(false),
		})
		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.S3Feed("example", new()
    {
        AccessKey = "given_access_key",
        SecretKey = "some_secret_key",
        UseMachineCredentials = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.S3Feed;
import com.pulumi.octopusdeploy.S3FeedArgs;
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 S3Feed("example", S3FeedArgs.builder()
            .accessKey("given_access_key")
            .secretKey("some_secret_key")
            .useMachineCredentials(false)
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:S3Feed
    properties:
      accessKey: given_access_key
      secretKey: some_secret_key
      useMachineCredentials: false

    Create S3Feed Resource

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

    Constructor syntax

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

@overload
def S3Feed(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           use_machine_credentials: Optional[bool] = None,
           access_key: Optional[str] = None,
           name: Optional[str] = None,
           password: Optional[str] = None,
           secret_key: Optional[str] = None,
           space_id: Optional[str] = None,
           username: Optional[str] = None)
    func NewS3Feed(ctx *Context, name string, args S3FeedArgs, opts ...ResourceOption) (*S3Feed, error)
    public S3Feed(string name, S3FeedArgs args, CustomResourceOptions? opts = null)
    public S3Feed(String name, S3FeedArgs args)
public S3Feed(String name, S3FeedArgs args, CustomResourceOptions options)

    type: octopusdeploy:S3Feed
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 S3FeedArgs
    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 S3FeedArgs
    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 S3FeedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args S3FeedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args S3FeedArgs
    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 s3feedResource = new Octopusdeploy.S3Feed("s3feedResource", new()
{
    UseMachineCredentials = false,
    AccessKey = "string",
    Name = "string",
    Password = "string",
    SecretKey = "string",
    SpaceId = "string",
    Username = "string",
});

    example, err := octopusdeploy.NewS3Feed(ctx, "s3feedResource", &octopusdeploy.S3FeedArgs{
	UseMachineCredentials: pulumi.Bool(false),
	AccessKey:             pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Password:              pulumi.String("string"),
	SecretKey:             pulumi.String("string"),
	SpaceId:               pulumi.String("string"),
	Username:              pulumi.String("string"),
})

    var s3feedResource = new S3Feed("s3feedResource", S3FeedArgs.builder()
    .useMachineCredentials(false)
    .accessKey("string")
    .name("string")
    .password("string")
    .secretKey("string")
    .spaceId("string")
    .username("string")
    .build());

    s3feed_resource = octopusdeploy.S3Feed("s3feedResource",
    use_machine_credentials=False,
    access_key="string",
    name="string",
    password="string",
    secret_key="string",
    space_id="string",
    username="string")

    const s3feedResource = new octopusdeploy.S3Feed("s3feedResource", {
    useMachineCredentials: false,
    accessKey: "string",
    name: "string",
    password: "string",
    secretKey: "string",
    spaceId: "string",
    username: "string",
});

    type: octopusdeploy:S3Feed
properties:
    accessKey: string
    name: string
    password: string
    secretKey: string
    spaceId: string
    useMachineCredentials: false
    username: string

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

    UseMachineCredentials bool
    When true will use credentials configured on the worker
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    Name string
    The name of this resource.
    Password string
    The password associated with this resource.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    Username string
    The username associated with this resource.
    UseMachineCredentials bool
    When true will use credentials configured on the worker
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    Name string
    The name of this resource.
    Password string
    The password associated with this resource.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    Username string
    The username associated with this resource.
    useMachineCredentials Boolean
    When true will use credentials configured on the worker
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services
    name String
    The name of this resource.
    password String
    The password associated with this resource.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this AWS S3 Bucket Feed.
    username String
    The username associated with this resource.
    useMachineCredentials boolean
    When true will use credentials configured on the worker
    accessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    name string
    The name of this resource.
    password string
    The password associated with this resource.
    secretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    username string
    The username associated with this resource.
    use_machine_credentials bool
    When true will use credentials configured on the worker
    access_key str
    The AWS access key to use when authenticating against Amazon Web Services
    name str
    The name of this resource.
    password str
    The password associated with this resource.
    secret_key str
    The AWS secret key to use when authenticating against Amazon Web Services.
    space_id str
    The space ID associated with this AWS S3 Bucket Feed.
    username str
    The username associated with this resource.
    useMachineCredentials Boolean
    When true will use credentials configured on the worker
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services
    name String
    The name of this resource.
    password String
    The password associated with this resource.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this AWS S3 Bucket Feed.
    username String
    The username associated with this resource.

    Outputs

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

    Get an existing S3Feed 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?: S3FeedState, opts?: CustomResourceOptions): S3Feed
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        secret_key: Optional[str] = None,
        space_id: Optional[str] = None,
        use_machine_credentials: Optional[bool] = None,
        username: Optional[str] = None) -> S3Feed
    func GetS3Feed(ctx *Context, name string, id IDInput, state *S3FeedState, opts ...ResourceOption) (*S3Feed, error)
    public static S3Feed Get(string name, Input<string> id, S3FeedState? state, CustomResourceOptions? opts = null)
    public static S3Feed get(String name, Output<String> id, S3FeedState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:S3Feed    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:
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    Name string
    The name of this resource.
    Password string
    The password associated with this resource.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    UseMachineCredentials bool
    When true will use credentials configured on the worker
    Username string
    The username associated with this resource.
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    Name string
    The name of this resource.
    Password string
    The password associated with this resource.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    UseMachineCredentials bool
    When true will use credentials configured on the worker
    Username string
    The username associated with this resource.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services
    name String
    The name of this resource.
    password String
    The password associated with this resource.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this AWS S3 Bucket Feed.
    useMachineCredentials Boolean
    When true will use credentials configured on the worker
    username String
    The username associated with this resource.
    accessKey string
    The AWS access key to use when authenticating against Amazon Web Services
    name string
    The name of this resource.
    password string
    The password associated with this resource.
    secretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId string
    The space ID associated with this AWS S3 Bucket Feed.
    useMachineCredentials boolean
    When true will use credentials configured on the worker
    username string
    The username associated with this resource.
    access_key str
    The AWS access key to use when authenticating against Amazon Web Services
    name str
    The name of this resource.
    password str
    The password associated with this resource.
    secret_key str
    The AWS secret key to use when authenticating against Amazon Web Services.
    space_id str
    The space ID associated with this AWS S3 Bucket Feed.
    use_machine_credentials bool
    When true will use credentials configured on the worker
    username str
    The username associated with this resource.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services
    name String
    The name of this resource.
    password String
    The password associated with this resource.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this AWS S3 Bucket Feed.
    useMachineCredentials Boolean
    When true will use credentials configured on the worker
    username String
    The username associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/s3Feed:S3Feed [options] octopusdeploy_s3_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.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy