Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. computeoptimizer
  5. EnrollmentStatus
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.computeoptimizer.EnrollmentStatus

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Manages AWS Compute Optimizer enrollment status.

    Example Usage

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

const example = new aws.computeoptimizer.EnrollmentStatus("example", {status: "Active"});

    import pulumi
import pulumi_aws as aws

example = aws.computeoptimizer.EnrollmentStatus("example", status="Active")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/computeoptimizer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := computeoptimizer.NewEnrollmentStatus(ctx, "example", &computeoptimizer.EnrollmentStatusArgs{
			Status: pulumi.String("Active"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ComputeOptimizer.EnrollmentStatus("example", new()
    {
        Status = "Active",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.computeoptimizer.EnrollmentStatus;
import com.pulumi.aws.computeoptimizer.EnrollmentStatusArgs;
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 EnrollmentStatus("example", EnrollmentStatusArgs.builder()
            .status("Active")
            .build());

    }
}

    resources:
  example:
    type: aws:computeoptimizer:EnrollmentStatus
    properties:
      status: Active

    Create EnrollmentStatus Resource

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

    Constructor syntax

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

@overload
def EnrollmentStatus(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     status: Optional[str] = None,
                     include_member_accounts: Optional[bool] = None,
                     timeouts: Optional[EnrollmentStatusTimeoutsArgs] = None)
    func NewEnrollmentStatus(ctx *Context, name string, args EnrollmentStatusArgs, opts ...ResourceOption) (*EnrollmentStatus, error)
    public EnrollmentStatus(string name, EnrollmentStatusArgs args, CustomResourceOptions? opts = null)
    public EnrollmentStatus(String name, EnrollmentStatusArgs args)
public EnrollmentStatus(String name, EnrollmentStatusArgs args, CustomResourceOptions options)

    type: aws:computeoptimizer:EnrollmentStatus
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 EnrollmentStatusArgs
    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 EnrollmentStatusArgs
    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 EnrollmentStatusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnrollmentStatusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnrollmentStatusArgs
    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 enrollmentStatusResource = new Aws.ComputeOptimizer.EnrollmentStatus("enrollmentStatusResource", new()
{
    Status = "string",
    IncludeMemberAccounts = false,
    Timeouts = new Aws.ComputeOptimizer.Inputs.EnrollmentStatusTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := computeoptimizer.NewEnrollmentStatus(ctx, "enrollmentStatusResource", &computeoptimizer.EnrollmentStatusArgs{
	Status:                pulumi.String("string"),
	IncludeMemberAccounts: pulumi.Bool(false),
	Timeouts: &computeoptimizer.EnrollmentStatusTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var enrollmentStatusResource = new EnrollmentStatus("enrollmentStatusResource", EnrollmentStatusArgs.builder()
    .status("string")
    .includeMemberAccounts(false)
    .timeouts(EnrollmentStatusTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    enrollment_status_resource = aws.computeoptimizer.EnrollmentStatus("enrollmentStatusResource",
    status="string",
    include_member_accounts=False,
    timeouts={
        "create": "string",
        "update": "string",
    })

    const enrollmentStatusResource = new aws.computeoptimizer.EnrollmentStatus("enrollmentStatusResource", {
    status: "string",
    includeMemberAccounts: false,
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: aws:computeoptimizer:EnrollmentStatus
properties:
    includeMemberAccounts: false
    status: string
    timeouts:
        create: string
        update: string

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

    Status string
    The enrollment status of the account. Valid values: Active, Inactive.
    IncludeMemberAccounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    Timeouts EnrollmentStatusTimeouts
    Status string
    The enrollment status of the account. Valid values: Active, Inactive.
    IncludeMemberAccounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    Timeouts EnrollmentStatusTimeoutsArgs
    status String
    The enrollment status of the account. Valid values: Active, Inactive.
    includeMemberAccounts Boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    timeouts EnrollmentStatusTimeouts
    status string
    The enrollment status of the account. Valid values: Active, Inactive.
    includeMemberAccounts boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    timeouts EnrollmentStatusTimeouts
    status str
    The enrollment status of the account. Valid values: Active, Inactive.
    include_member_accounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    timeouts EnrollmentStatusTimeoutsArgs
    status String
    The enrollment status of the account. Valid values: Active, Inactive.
    includeMemberAccounts Boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EnrollmentStatus resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    NumberOfMemberAccountsOptedIn int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    Id string
    The provider-assigned unique ID for this managed resource.
    NumberOfMemberAccountsOptedIn int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    id String
    The provider-assigned unique ID for this managed resource.
    numberOfMemberAccountsOptedIn Integer
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    id string
    The provider-assigned unique ID for this managed resource.
    numberOfMemberAccountsOptedIn number
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    id str
    The provider-assigned unique ID for this managed resource.
    number_of_member_accounts_opted_in int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    id String
    The provider-assigned unique ID for this managed resource.
    numberOfMemberAccountsOptedIn Number
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.

    Look up Existing EnrollmentStatus Resource

    Get an existing EnrollmentStatus 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?: EnrollmentStatusState, opts?: CustomResourceOptions): EnrollmentStatus
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        include_member_accounts: Optional[bool] = None,
        number_of_member_accounts_opted_in: Optional[int] = None,
        status: Optional[str] = None,
        timeouts: Optional[EnrollmentStatusTimeoutsArgs] = None) -> EnrollmentStatus
    func GetEnrollmentStatus(ctx *Context, name string, id IDInput, state *EnrollmentStatusState, opts ...ResourceOption) (*EnrollmentStatus, error)
    public static EnrollmentStatus Get(string name, Input<string> id, EnrollmentStatusState? state, CustomResourceOptions? opts = null)
    public static EnrollmentStatus get(String name, Output<String> id, EnrollmentStatusState 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:
    IncludeMemberAccounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    NumberOfMemberAccountsOptedIn int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    Status string
    The enrollment status of the account. Valid values: Active, Inactive.
    Timeouts EnrollmentStatusTimeouts
    IncludeMemberAccounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    NumberOfMemberAccountsOptedIn int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    Status string
    The enrollment status of the account. Valid values: Active, Inactive.
    Timeouts EnrollmentStatusTimeoutsArgs
    includeMemberAccounts Boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    numberOfMemberAccountsOptedIn Integer
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    status String
    The enrollment status of the account. Valid values: Active, Inactive.
    timeouts EnrollmentStatusTimeouts
    includeMemberAccounts boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    numberOfMemberAccountsOptedIn number
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    status string
    The enrollment status of the account. Valid values: Active, Inactive.
    timeouts EnrollmentStatusTimeouts
    include_member_accounts bool
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    number_of_member_accounts_opted_in int
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    status str
    The enrollment status of the account. Valid values: Active, Inactive.
    timeouts EnrollmentStatusTimeoutsArgs
    includeMemberAccounts Boolean
    Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is false.
    numberOfMemberAccountsOptedIn Number
    The count of organization member accounts that are opted in to the service, if your account is an organization management account.
    status String
    The enrollment status of the account. Valid values: Active, Inactive.
    timeouts Property Map

    Supporting Types

    EnrollmentStatusTimeouts, EnrollmentStatusTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import enrollment status using the account ID. For example:

    $ pulumi import aws:computeoptimizer/enrollmentStatus:EnrollmentStatus example 123456789012

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws