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

octopusdeploy.AwsOpenidConnectAccount

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 AWS OIDC accounts in Octopus Deploy.

    Create AwsOpenidConnectAccount Resource

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

    Constructor syntax

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

@overload
def AwsOpenidConnectAccount(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            role_arn: Optional[str] = None,
                            name: Optional[str] = None,
                            description: Optional[str] = None,
                            environments: Optional[Sequence[str]] = None,
                            execution_subject_keys: Optional[Sequence[str]] = None,
                            health_subject_keys: Optional[Sequence[str]] = None,
                            account_test_subject_keys: Optional[Sequence[str]] = None,
                            aws_openid_connect_account_id: Optional[str] = None,
                            session_duration: Optional[float] = None,
                            space_id: Optional[str] = None,
                            tenant_tags: Optional[Sequence[str]] = None,
                            tenanted_deployment_participation: Optional[str] = None,
                            tenants: Optional[Sequence[str]] = None)
    func NewAwsOpenidConnectAccount(ctx *Context, name string, args AwsOpenidConnectAccountArgs, opts ...ResourceOption) (*AwsOpenidConnectAccount, error)
    public AwsOpenidConnectAccount(string name, AwsOpenidConnectAccountArgs args, CustomResourceOptions? opts = null)
    public AwsOpenidConnectAccount(String name, AwsOpenidConnectAccountArgs args)
public AwsOpenidConnectAccount(String name, AwsOpenidConnectAccountArgs args, CustomResourceOptions options)

    type: octopusdeploy:AwsOpenidConnectAccount
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 AwsOpenidConnectAccountArgs
    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 AwsOpenidConnectAccountArgs
    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 AwsOpenidConnectAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsOpenidConnectAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsOpenidConnectAccountArgs
    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 awsOpenidConnectAccountResource = new Octopusdeploy.AwsOpenidConnectAccount("awsOpenidConnectAccountResource", new()
{
    RoleArn = "string",
    Name = "string",
    Description = "string",
    Environments = new[]
    {
        "string",
    },
    ExecutionSubjectKeys = new[]
    {
        "string",
    },
    HealthSubjectKeys = new[]
    {
        "string",
    },
    AccountTestSubjectKeys = new[]
    {
        "string",
    },
    AwsOpenidConnectAccountId = "string",
    SessionDuration = 0,
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
    TenantedDeploymentParticipation = "string",
    Tenants = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewAwsOpenidConnectAccount(ctx, "awsOpenidConnectAccountResource", &octopusdeploy.AwsOpenidConnectAccountArgs{
	RoleArn:     pulumi.String("string"),
	Name:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Environments: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExecutionSubjectKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	HealthSubjectKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	AccountTestSubjectKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	AwsOpenidConnectAccountId: pulumi.String("string"),
	SessionDuration:           pulumi.Float64(0),
	SpaceId:                   pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantedDeploymentParticipation: pulumi.String("string"),
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var awsOpenidConnectAccountResource = new AwsOpenidConnectAccount("awsOpenidConnectAccountResource", AwsOpenidConnectAccountArgs.builder()
    .roleArn("string")
    .name("string")
    .description("string")
    .environments("string")
    .executionSubjectKeys("string")
    .healthSubjectKeys("string")
    .accountTestSubjectKeys("string")
    .awsOpenidConnectAccountId("string")
    .sessionDuration(0)
    .spaceId("string")
    .tenantTags("string")
    .tenantedDeploymentParticipation("string")
    .tenants("string")
    .build());

    aws_openid_connect_account_resource = octopusdeploy.AwsOpenidConnectAccount("awsOpenidConnectAccountResource",
    role_arn="string",
    name="string",
    description="string",
    environments=["string"],
    execution_subject_keys=["string"],
    health_subject_keys=["string"],
    account_test_subject_keys=["string"],
    aws_openid_connect_account_id="string",
    session_duration=0,
    space_id="string",
    tenant_tags=["string"],
    tenanted_deployment_participation="string",
    tenants=["string"])

    const awsOpenidConnectAccountResource = new octopusdeploy.AwsOpenidConnectAccount("awsOpenidConnectAccountResource", {
    roleArn: "string",
    name: "string",
    description: "string",
    environments: ["string"],
    executionSubjectKeys: ["string"],
    healthSubjectKeys: ["string"],
    accountTestSubjectKeys: ["string"],
    awsOpenidConnectAccountId: "string",
    sessionDuration: 0,
    spaceId: "string",
    tenantTags: ["string"],
    tenantedDeploymentParticipation: "string",
    tenants: ["string"],
});

    type: octopusdeploy:AwsOpenidConnectAccount
properties:
    accountTestSubjectKeys:
        - string
    awsOpenidConnectAccountId: string
    description: string
    environments:
        - string
    executionSubjectKeys:
        - string
    healthSubjectKeys:
        - string
    name: string
    roleArn: string
    sessionDuration: 0
    spaceId: string
    tenantTags:
        - string
    tenantedDeploymentParticipation: string
    tenants:
        - string

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

    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    AccountTestSubjectKeys List<string>
    Keys to include in an account test. Valid options are: space, account, type
    AwsOpenidConnectAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS OIDC account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    HealthSubjectKeys List<string>
    Keys to include in a health check. Valid options are space, account, target, type
    Name string
    The name of this AWS OIDC account.
    SessionDuration double
    The duration, in seconds, of the role session.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    AccountTestSubjectKeys []string
    Keys to include in an account test. Valid options are: space, account, type
    AwsOpenidConnectAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS OIDC account.
    Environments []string
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    HealthSubjectKeys []string
    Keys to include in a health check. Valid options are space, account, target, type
    Name string
    The name of this AWS OIDC account.
    SessionDuration float64
    The duration, in seconds, of the role session.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    accountTestSubjectKeys List<String>
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS OIDC account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys List<String>
    Keys to include in a health check. Valid options are space, account, target, type
    name String
    The name of this AWS OIDC account.
    sessionDuration Double
    The duration, in seconds, of the role session.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    roleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    accountTestSubjectKeys string[]
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId string
    The ID of this resource.
    description string
    A user-friendly description of this AWS OIDC account.
    environments string[]
    A list of environment IDs associated with this resource.
    executionSubjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys string[]
    Keys to include in a health check. Valid options are space, account, target, type
    name string
    The name of this AWS OIDC account.
    sessionDuration number
    The duration, in seconds, of the role session.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    role_arn str
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    account_test_subject_keys Sequence[str]
    Keys to include in an account test. Valid options are: space, account, type
    aws_openid_connect_account_id str
    The ID of this resource.
    description str
    A user-friendly description of this AWS OIDC account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    execution_subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    health_subject_keys Sequence[str]
    Keys to include in a health check. Valid options are space, account, target, type
    name str
    The name of this AWS OIDC account.
    session_duration float
    The duration, in seconds, of the role session.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    accountTestSubjectKeys List<String>
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS OIDC account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys List<String>
    Keys to include in a health check. Valid options are space, account, target, type
    name String
    The name of this AWS OIDC account.
    sessionDuration Number
    The duration, in seconds, of the role session.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Outputs

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

    Get an existing AwsOpenidConnectAccount 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?: AwsOpenidConnectAccountState, opts?: CustomResourceOptions): AwsOpenidConnectAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_test_subject_keys: Optional[Sequence[str]] = None,
        aws_openid_connect_account_id: Optional[str] = None,
        description: Optional[str] = None,
        environments: Optional[Sequence[str]] = None,
        execution_subject_keys: Optional[Sequence[str]] = None,
        health_subject_keys: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        role_arn: Optional[str] = None,
        session_duration: Optional[float] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None,
        tenanted_deployment_participation: Optional[str] = None,
        tenants: Optional[Sequence[str]] = None) -> AwsOpenidConnectAccount
    func GetAwsOpenidConnectAccount(ctx *Context, name string, id IDInput, state *AwsOpenidConnectAccountState, opts ...ResourceOption) (*AwsOpenidConnectAccount, error)
    public static AwsOpenidConnectAccount Get(string name, Input<string> id, AwsOpenidConnectAccountState? state, CustomResourceOptions? opts = null)
    public static AwsOpenidConnectAccount get(String name, Output<String> id, AwsOpenidConnectAccountState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:AwsOpenidConnectAccount    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:
    AccountTestSubjectKeys List<string>
    Keys to include in an account test. Valid options are: space, account, type
    AwsOpenidConnectAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS OIDC account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    HealthSubjectKeys List<string>
    Keys to include in a health check. Valid options are space, account, target, type
    Name string
    The name of this AWS OIDC account.
    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    SessionDuration double
    The duration, in seconds, of the role session.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    AccountTestSubjectKeys []string
    Keys to include in an account test. Valid options are: space, account, type
    AwsOpenidConnectAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS OIDC account.
    Environments []string
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    HealthSubjectKeys []string
    Keys to include in a health check. Valid options are space, account, target, type
    Name string
    The name of this AWS OIDC account.
    RoleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    SessionDuration float64
    The duration, in seconds, of the role session.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    accountTestSubjectKeys List<String>
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS OIDC account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys List<String>
    Keys to include in a health check. Valid options are space, account, target, type
    name String
    The name of this AWS OIDC account.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration Double
    The duration, in seconds, of the role session.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    accountTestSubjectKeys string[]
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId string
    The ID of this resource.
    description string
    A user-friendly description of this AWS OIDC account.
    environments string[]
    A list of environment IDs associated with this resource.
    executionSubjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys string[]
    Keys to include in a health check. Valid options are space, account, target, type
    name string
    The name of this AWS OIDC account.
    roleArn string
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration number
    The duration, in seconds, of the role session.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    account_test_subject_keys Sequence[str]
    Keys to include in an account test. Valid options are: space, account, type
    aws_openid_connect_account_id str
    The ID of this resource.
    description str
    A user-friendly description of this AWS OIDC account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    execution_subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    health_subject_keys Sequence[str]
    Keys to include in a health check. Valid options are space, account, target, type
    name str
    The name of this AWS OIDC account.
    role_arn str
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    session_duration float
    The duration, in seconds, of the role session.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    accountTestSubjectKeys List<String>
    Keys to include in an account test. Valid options are: space, account, type
    awsOpenidConnectAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS OIDC account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type
    healthSubjectKeys List<String>
    Keys to include in a health check. Valid options are space, account, target, type
    name String
    The name of this AWS OIDC account.
    roleArn String
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    sessionDuration Number
    The duration, in seconds, of the role session.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    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