Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. kinesis
  6. AccountSettings
Viewing docs for AWS v7.33.0
published on Monday, Jun 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.kinesis.AccountSettings

aws logo
Viewing docs for AWS v7.33.0
published on Monday, Jun 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages account-level settings for Amazon Kinesis Data Streams.

    Deletion of this resource will not modify any settings, only remove the resource from state.

    Example Usage

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

const example = new aws.kinesis.AccountSettings("example", {minimumThroughputBillingCommitment: {
    status: "ENABLED",
}});

    import pulumi
import pulumi_aws as aws

example = aws.kinesis.AccountSettings("example", minimum_throughput_billing_commitment={
    "status": "ENABLED",
})

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kinesis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kinesis.NewAccountSettings(ctx, "example", &kinesis.AccountSettingsArgs{
			MinimumThroughputBillingCommitment: &kinesis.AccountSettingsMinimumThroughputBillingCommitmentArgs{
				Status: pulumi.String("ENABLED"),
			},
		})
		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.Kinesis.AccountSettings("example", new()
    {
        MinimumThroughputBillingCommitment = new Aws.Kinesis.Inputs.AccountSettingsMinimumThroughputBillingCommitmentArgs
        {
            Status = "ENABLED",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.AccountSettings;
import com.pulumi.aws.kinesis.AccountSettingsArgs;
import com.pulumi.aws.kinesis.inputs.AccountSettingsMinimumThroughputBillingCommitmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 AccountSettings("example", AccountSettingsArgs.builder()
            .minimumThroughputBillingCommitment(AccountSettingsMinimumThroughputBillingCommitmentArgs.builder()
                .status("ENABLED")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:kinesis:AccountSettings
    properties:
      minimumThroughputBillingCommitment:
        status: ENABLED

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kinesis_accountsettings" "example" {
  minimum_throughput_billing_commitment = {
    status = "ENABLED"
  }
}

    Create AccountSettings Resource

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

    Constructor syntax

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

@overload
def AccountSettings(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    minimum_throughput_billing_commitment: Optional[AccountSettingsMinimumThroughputBillingCommitmentArgs] = None,
                    region: Optional[str] = None)
    func NewAccountSettings(ctx *Context, name string, args *AccountSettingsArgs, opts ...ResourceOption) (*AccountSettings, error)
    public AccountSettings(string name, AccountSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public AccountSettings(String name, AccountSettingsArgs args)
public AccountSettings(String name, AccountSettingsArgs args, CustomResourceOptions options)

    type: aws:kinesis:AccountSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_kinesis_accountsettings" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AccountSettingsArgs
    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 AccountSettingsArgs
    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 AccountSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountSettingsArgs
    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 accountSettingsResource = new Aws.Kinesis.AccountSettings("accountSettingsResource", new()
{
    MinimumThroughputBillingCommitment = new Aws.Kinesis.Inputs.AccountSettingsMinimumThroughputBillingCommitmentArgs
    {
        Status = "string",
        EarliestAllowedEndAt = "string",
        EndedAt = "string",
        StartedAt = "string",
        StatusActual = "string",
    },
    Region = "string",
});

    example, err := kinesis.NewAccountSettings(ctx, "accountSettingsResource", &kinesis.AccountSettingsArgs{
	MinimumThroughputBillingCommitment: &kinesis.AccountSettingsMinimumThroughputBillingCommitmentArgs{
		Status:               pulumi.String("string"),
		EarliestAllowedEndAt: pulumi.String("string"),
		EndedAt:              pulumi.String("string"),
		StartedAt:            pulumi.String("string"),
		StatusActual:         pulumi.String("string"),
	},
	Region: pulumi.String("string"),
})

    resource "aws_kinesis_accountsettings" "accountSettingsResource" {
  minimum_throughput_billing_commitment = {
    status                  = "string"
    earliest_allowed_end_at = "string"
    ended_at                = "string"
    started_at              = "string"
    status_actual           = "string"
  }
  region = "string"
}

    var accountSettingsResource = new com.pulumi.aws.kinesis.AccountSettings("accountSettingsResource", com.pulumi.aws.kinesis.AccountSettingsArgs.builder()
    .minimumThroughputBillingCommitment(AccountSettingsMinimumThroughputBillingCommitmentArgs.builder()
        .status("string")
        .earliestAllowedEndAt("string")
        .endedAt("string")
        .startedAt("string")
        .statusActual("string")
        .build())
    .region("string")
    .build());

    account_settings_resource = aws.kinesis.AccountSettings("accountSettingsResource",
    minimum_throughput_billing_commitment={
        "status": "string",
        "earliest_allowed_end_at": "string",
        "ended_at": "string",
        "started_at": "string",
        "status_actual": "string",
    },
    region="string")

    const accountSettingsResource = new aws.kinesis.AccountSettings("accountSettingsResource", {
    minimumThroughputBillingCommitment: {
        status: "string",
        earliestAllowedEndAt: "string",
        endedAt: "string",
        startedAt: "string",
        statusActual: "string",
    },
    region: "string",
});

    type: aws:kinesis:AccountSettings
properties:
    minimumThroughputBillingCommitment:
        earliestAllowedEndAt: string
        endedAt: string
        startedAt: string
        status: string
        statusActual: string
    region: string

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

    MinimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    MinimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitmentArgs
    Minimum throughput billing commitment configuration. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimum_throughput_billing_commitment object
    Minimum throughput billing commitment configuration. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimum_throughput_billing_commitment AccountSettingsMinimumThroughputBillingCommitmentArgs
    Minimum throughput billing commitment configuration. Detailed below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment Property Map
    Minimum throughput billing commitment configuration. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

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

    Get an existing AccountSettings 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?: AccountSettingsState, opts?: CustomResourceOptions): AccountSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        minimum_throughput_billing_commitment: Optional[AccountSettingsMinimumThroughputBillingCommitmentArgs] = None,
        region: Optional[str] = None) -> AccountSettings
    func GetAccountSettings(ctx *Context, name string, id IDInput, state *AccountSettingsState, opts ...ResourceOption) (*AccountSettings, error)
    public static AccountSettings Get(string name, Input<string> id, AccountSettingsState? state, CustomResourceOptions? opts = null)
    public static AccountSettings get(String name, Output<String> id, AccountSettingsState state, CustomResourceOptions options)
    resources:  _:    type: aws:kinesis:AccountSettings    get:      id: ${id}
    import {
  to = aws_kinesis_accountsettings.example
  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:
    MinimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    MinimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitmentArgs
    Minimum throughput billing commitment configuration. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimum_throughput_billing_commitment object
    Minimum throughput billing commitment configuration. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment AccountSettingsMinimumThroughputBillingCommitment
    Minimum throughput billing commitment configuration. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimum_throughput_billing_commitment AccountSettingsMinimumThroughputBillingCommitmentArgs
    Minimum throughput billing commitment configuration. Detailed below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    minimumThroughputBillingCommitment Property Map
    Minimum throughput billing commitment configuration. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Supporting Types

    AccountSettingsMinimumThroughputBillingCommitment, AccountSettingsMinimumThroughputBillingCommitmentArgs

    Status string
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    EarliestAllowedEndAt string
    EndedAt string
    StartedAt string
    StatusActual string
    Status string
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    EarliestAllowedEndAt string
    EndedAt string
    StartedAt string
    StatusActual string
    status string
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    earliest_allowed_end_at string
    ended_at string
    started_at string
    status_actual string
    status String
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    earliestAllowedEndAt String
    endedAt String
    startedAt String
    statusActual String
    status string
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    earliestAllowedEndAt string
    endedAt string
    startedAt string
    statusActual string
    status str
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    earliest_allowed_end_at str
    ended_at str
    started_at str
    status_actual str
    status String
    Desired status of the minimum throughput billing commitment. Valid values: ENABLED, DISABLED.
    earliestAllowedEndAt String
    endedAt String
    startedAt String
    statusActual String

    Import

    Identity Schema

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import Kinesis account settings using the region name. For example:

    $ pulumi import aws:kinesis/accountSettings:AccountSettings example us-west-2

    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
    Viewing docs for AWS v7.33.0
    published on Monday, Jun 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial