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

octopusdeploy.AwsElasticContainerRegistry

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 an AWS Elastic Container Registry in Octopus Deploy.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.AwsElasticContainerRegistry;
import com.pulumi.octopusdeploy.AwsElasticContainerRegistryArgs;
import com.pulumi.octopusdeploy.inputs.AwsElasticContainerRegistryOidcAuthenticationArgs;
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 AwsElasticContainerRegistry("example", AwsElasticContainerRegistryArgs.builder()
            .accessKey("access-key")
            .region("us-east-1")
            .secretKey("secret-key")
            .build());

        var exampleWithOidc = new AwsElasticContainerRegistry("exampleWithOidc", AwsElasticContainerRegistryArgs.builder()
            .oidcAuthentication(AwsElasticContainerRegistryOidcAuthenticationArgs.builder()
                .role_arn("role_arn_value")
                .session_duration(3600)
                .subject_keys(                
                    "feed",
                    "space")
                .build())
            .region("us-east-1")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:AwsElasticContainerRegistry
    properties:
      accessKey: access-key
      region: us-east-1
      secretKey: secret-key
  exampleWithOidc:
    type: octopusdeploy:AwsElasticContainerRegistry
    properties:
      oidcAuthentication:
        role_arn: role_arn_value
        session_duration: 3600
        subject_keys:
          - feed
          - space
      region: us-east-1

    Create AwsElasticContainerRegistry Resource

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

    Constructor syntax

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

@overload
def AwsElasticContainerRegistry(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                region: Optional[str] = None,
                                access_key: Optional[str] = None,
                                name: Optional[str] = None,
                                oidc_authentication: Optional[AwsElasticContainerRegistryOidcAuthenticationArgs] = None,
                                package_acquisition_location_options: Optional[Sequence[str]] = None,
                                secret_key: Optional[str] = None,
                                space_id: Optional[str] = None)
    func NewAwsElasticContainerRegistry(ctx *Context, name string, args AwsElasticContainerRegistryArgs, opts ...ResourceOption) (*AwsElasticContainerRegistry, error)
    public AwsElasticContainerRegistry(string name, AwsElasticContainerRegistryArgs args, CustomResourceOptions? opts = null)
    public AwsElasticContainerRegistry(String name, AwsElasticContainerRegistryArgs args)
public AwsElasticContainerRegistry(String name, AwsElasticContainerRegistryArgs args, CustomResourceOptions options)

    type: octopusdeploy:AwsElasticContainerRegistry
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 AwsElasticContainerRegistryArgs
    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 AwsElasticContainerRegistryArgs
    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 AwsElasticContainerRegistryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsElasticContainerRegistryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsElasticContainerRegistryArgs
    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 awsElasticContainerRegistryResource = new Octopusdeploy.AwsElasticContainerRegistry("awsElasticContainerRegistryResource", new()
{
    Region = "string",
    AccessKey = "string",
    Name = "string",
    OidcAuthentication = new Octopusdeploy.Inputs.AwsElasticContainerRegistryOidcAuthenticationArgs
    {
        Audience = "string",
        RoleArn = "string",
        SessionDuration = "string",
        SubjectKeys = new[]
        {
            "string",
        },
    },
    PackageAcquisitionLocationOptions = new[]
    {
        "string",
    },
    SecretKey = "string",
    SpaceId = "string",
});

    example, err := octopusdeploy.NewAwsElasticContainerRegistry(ctx, "awsElasticContainerRegistryResource", &octopusdeploy.AwsElasticContainerRegistryArgs{
	Region:    pulumi.String("string"),
	AccessKey: pulumi.String("string"),
	Name:      pulumi.String("string"),
	OidcAuthentication: &octopusdeploy.AwsElasticContainerRegistryOidcAuthenticationArgs{
		Audience:        pulumi.String("string"),
		RoleArn:         pulumi.String("string"),
		SessionDuration: pulumi.String("string"),
		SubjectKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	PackageAcquisitionLocationOptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecretKey: pulumi.String("string"),
	SpaceId:   pulumi.String("string"),
})

    var awsElasticContainerRegistryResource = new AwsElasticContainerRegistry("awsElasticContainerRegistryResource", AwsElasticContainerRegistryArgs.builder()
    .region("string")
    .accessKey("string")
    .name("string")
    .oidcAuthentication(AwsElasticContainerRegistryOidcAuthenticationArgs.builder()
        .audience("string")
        .roleArn("string")
        .sessionDuration("string")
        .subjectKeys("string")
        .build())
    .packageAcquisitionLocationOptions("string")
    .secretKey("string")
    .spaceId("string")
    .build());

    aws_elastic_container_registry_resource = octopusdeploy.AwsElasticContainerRegistry("awsElasticContainerRegistryResource",
    region="string",
    access_key="string",
    name="string",
    oidc_authentication={
        "audience": "string",
        "role_arn": "string",
        "session_duration": "string",
        "subject_keys": ["string"],
    },
    package_acquisition_location_options=["string"],
    secret_key="string",
    space_id="string")

    const awsElasticContainerRegistryResource = new octopusdeploy.AwsElasticContainerRegistry("awsElasticContainerRegistryResource", {
    region: "string",
    accessKey: "string",
    name: "string",
    oidcAuthentication: {
        audience: "string",
        roleArn: "string",
        sessionDuration: "string",
        subjectKeys: ["string"],
    },
    packageAcquisitionLocationOptions: ["string"],
    secretKey: "string",
    spaceId: "string",
});

    type: octopusdeploy:AwsElasticContainerRegistry
properties:
    accessKey: string
    name: string
    oidcAuthentication:
        audience: string
        roleArn: string
        sessionDuration: string
        subjectKeys:
            - string
    packageAcquisitionLocationOptions:
        - string
    region: string
    secretKey: string
    spaceId: string

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

    Region string
    The AWS region where the registry resides.
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    Name string
    The name of this resource.
    OidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    PackageAcquisitionLocationOptions List<string>
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this aws elastic container registry.
    Region string
    The AWS region where the registry resides.
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    Name string
    The name of this resource.
    OidcAuthentication AwsElasticContainerRegistryOidcAuthenticationArgs
    PackageAcquisitionLocationOptions []string
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this aws elastic container registry.
    region String
    The AWS region where the registry resides.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    name String
    The name of this resource.
    oidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    packageAcquisitionLocationOptions List<String>
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this aws elastic container registry.
    region string
    The AWS region where the registry resides.
    accessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    name string
    The name of this resource.
    oidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    packageAcquisitionLocationOptions string[]
    secretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId string
    The space ID associated with this aws elastic container registry.
    region str
    The AWS region where the registry resides.
    access_key str
    The AWS access key to use when authenticating against Amazon Web Services.
    name str
    The name of this resource.
    oidc_authentication AwsElasticContainerRegistryOidcAuthenticationArgs
    package_acquisition_location_options Sequence[str]
    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 elastic container registry.
    region String
    The AWS region where the registry resides.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    name String
    The name of this resource.
    oidcAuthentication Property Map
    packageAcquisitionLocationOptions List<String>
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this aws elastic container registry.

    Outputs

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

    Get an existing AwsElasticContainerRegistry 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?: AwsElasticContainerRegistryState, opts?: CustomResourceOptions): AwsElasticContainerRegistry
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        name: Optional[str] = None,
        oidc_authentication: Optional[AwsElasticContainerRegistryOidcAuthenticationArgs] = None,
        package_acquisition_location_options: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        secret_key: Optional[str] = None,
        space_id: Optional[str] = None) -> AwsElasticContainerRegistry
    func GetAwsElasticContainerRegistry(ctx *Context, name string, id IDInput, state *AwsElasticContainerRegistryState, opts ...ResourceOption) (*AwsElasticContainerRegistry, error)
    public static AwsElasticContainerRegistry Get(string name, Input<string> id, AwsElasticContainerRegistryState? state, CustomResourceOptions? opts = null)
    public static AwsElasticContainerRegistry get(String name, Output<String> id, AwsElasticContainerRegistryState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:AwsElasticContainerRegistry    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.
    OidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    PackageAcquisitionLocationOptions List<string>
    Region string
    The AWS region where the registry resides.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this aws elastic container registry.
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    Name string
    The name of this resource.
    OidcAuthentication AwsElasticContainerRegistryOidcAuthenticationArgs
    PackageAcquisitionLocationOptions []string
    Region string
    The AWS region where the registry resides.
    SecretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    SpaceId string
    The space ID associated with this aws elastic container registry.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    name String
    The name of this resource.
    oidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    packageAcquisitionLocationOptions List<String>
    region String
    The AWS region where the registry resides.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this aws elastic container registry.
    accessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    name string
    The name of this resource.
    oidcAuthentication AwsElasticContainerRegistryOidcAuthentication
    packageAcquisitionLocationOptions string[]
    region string
    The AWS region where the registry resides.
    secretKey string
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId string
    The space ID associated with this aws elastic container registry.
    access_key str
    The AWS access key to use when authenticating against Amazon Web Services.
    name str
    The name of this resource.
    oidc_authentication AwsElasticContainerRegistryOidcAuthenticationArgs
    package_acquisition_location_options Sequence[str]
    region str
    The AWS region where the registry resides.
    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 elastic container registry.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    name String
    The name of this resource.
    oidcAuthentication Property Map
    packageAcquisitionLocationOptions List<String>
    region String
    The AWS region where the registry resides.
    secretKey String
    The AWS secret key to use when authenticating against Amazon Web Services.
    spaceId String
    The space ID associated with this aws elastic container registry.

    Supporting Types

    AwsElasticContainerRegistryOidcAuthentication, AwsElasticContainerRegistryOidcAuthenticationArgs

    Audience string
    Audience to use when authenticating against Amazon Web Services.
    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    SessionDuration string
    Assumed role session duration (in seconds)
    SubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, feed.
    Audience string
    Audience to use when authenticating against Amazon Web Services.
    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    SessionDuration string
    Assumed role session duration (in seconds)
    SubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, feed.
    audience String
    Audience to use when authenticating against Amazon Web Services.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration String
    Assumed role session duration (in seconds)
    subjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, feed.
    audience string
    Audience to use when authenticating against Amazon Web Services.
    roleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration string
    Assumed role session duration (in seconds)
    subjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, feed.
    audience str
    Audience to use when authenticating against Amazon Web Services.
    role_arn str
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    session_duration str
    Assumed role session duration (in seconds)
    subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, feed.
    audience String
    Audience to use when authenticating against Amazon Web Services.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration String
    Assumed role session duration (in seconds)
    subjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, feed.

    Import

    $ pulumi import octopusdeploy:index/awsElasticContainerRegistry:AwsElasticContainerRegistry [options] octopusdeploy_aws_elastic_container_registry.<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