Module cfg

@pulumi/aws > cfg

Index

cfg/aggregateAuthorization.ts cfg/configurationAggregator.ts cfg/deliveryChannel.ts cfg/recorder.ts cfg/recorderStatus.ts cfg/rule.ts

class AggregateAuthorization

Manages an AWS Config Aggregate Authorization

constructor

new AggregateAuthorization(name: string, args: AggregateAuthorizationArgs, opts?: pulumi.CustomResourceOptions)

Create a AggregateAuthorization resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AggregateAuthorizationState): AggregateAuthorization

Get an existing AggregateAuthorization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountId

public accountId: pulumi.Output<string>;

Account ID

property arn

public arn: pulumi.Output<string>;

The ARN of the authorization

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property region

public region: pulumi.Output<string>;

Region

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ConfigurationAggregator

Manages an AWS Config Configuration Aggregator

constructor

new ConfigurationAggregator(name: string, args?: ConfigurationAggregatorArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigurationAggregator resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationAggregatorState): ConfigurationAggregator

Get an existing ConfigurationAggregator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountAggregationSource

public accountAggregationSource: pulumi.Output<{ ... } | undefined>;

The account(s) to aggregate config data from as documented below.

property arn

public arn: pulumi.Output<string>;

The ARN of the aggregator

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the configuration aggregator.

property organizationAggregationSource

public organizationAggregationSource: pulumi.Output<{ ... } | undefined>;

The organization to aggregate config data from as documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class DeliveryChannel

Provides an AWS Config Delivery Channel.

~> Note: Delivery Channel requires a Configuration Recorder to be present. Use of depends_on (as shown below) is recommended to avoid race conditions.

constructor

new DeliveryChannel(name: string, args: DeliveryChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a DeliveryChannel resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeliveryChannelState): DeliveryChannel

Get an existing DeliveryChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the delivery channel. Defaults to default. Changing it recreates the resource.

property s3BucketName

public s3BucketName: pulumi.Output<string>;

The name of the S3 bucket used to store the configuration history.

property s3KeyPrefix

public s3KeyPrefix: pulumi.Output<string | undefined>;

The prefix for the specified S3 bucket.

property snapshotDeliveryProperties

public snapshotDeliveryProperties: pulumi.Output<{ ... } | undefined>;

Options for how AWS Config delivers configuration snapshots. See below

property snsTopicArn

public snsTopicArn: pulumi.Output<string | undefined>;

The ARN of the SNS topic that AWS Config delivers notifications to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Recorder

Provides an AWS Config Configuration Recorder. Please note that this resource does not start the created recorder automatically.

~> Note: Starting the Configuration Recorder requires a delivery channel (while delivery channel creation requires Configuration Recorder). This is why aws_config_configuration_recorder_status is a separate resource.

constructor

new Recorder(name: string, args: RecorderArgs, opts?: pulumi.CustomResourceOptions)

Create a Recorder resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RecorderState): Recorder

Get an existing Recorder resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the recorder. Defaults to default. Changing it recreates the resource.

property recordingGroup

public recordingGroup: pulumi.Output<{ ... }>;

Recording group - see below.

property roleArn

public roleArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the IAM role. used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See AWS Docs for more details.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class RecorderStatus

Manages status (recording / stopped) of an AWS Config Configuration Recorder.

~> Note: Starting Configuration Recorder requires a Delivery Channel to be present. Use of depends_on (as shown below) is recommended to avoid race conditions.

constructor

new RecorderStatus(name: string, args: RecorderStatusArgs, opts?: pulumi.CustomResourceOptions)

Create a RecorderStatus resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RecorderStatusState): RecorderStatus

Get an existing RecorderStatus resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isEnabled

public isEnabled: pulumi.Output<boolean>;

Whether the configuration recorder should be enabled or disabled.

property name

public name: pulumi.Output<string>;

The name of the recorder

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Rule

Provides an AWS Config Rule.

~> Note: Config Rule requires an existing Configuration Recorder to be present. Use of depends_on is recommended (as shown below) to avoid race conditions.

constructor

new Rule(name: string, args: RuleArgs, opts?: pulumi.CustomResourceOptions)

Create a Rule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RuleState): Rule

Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the config rule

property description

public description: pulumi.Output<string | undefined>;

Description of the rule

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inputParameters

public inputParameters: pulumi.Output<string | undefined>;

A string in JSON format that is passed to the AWS Config rule Lambda function.

property maximumExecutionFrequency

public maximumExecutionFrequency: pulumi.Output<string | undefined>;

The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If specified, requires message_type to be ScheduledNotification.

property name

public name: pulumi.Output<string>;

The name of the rule

property ruleId

public ruleId: pulumi.Output<string>;

The ID of the config rule

property scope

public scope: pulumi.Output<{ ... } | undefined>;

Scope defines which resources can trigger an evaluation for the rule as documented below.

property source

public source: pulumi.Output<{ ... }>;

Source specifies the rule owner, the rule identifier, and the notifications that cause the function to evaluate your AWS resources as documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface AggregateAuthorizationArgs

The set of arguments for constructing a AggregateAuthorization resource.

property accountId

accountId: pulumi.Input<string>;

Account ID

property region

region: pulumi.Input<string>;

Region

interface AggregateAuthorizationState

Input properties used for looking up and filtering AggregateAuthorization resources.

property accountId

accountId?: pulumi.Input<string>;

Account ID

property arn

arn?: pulumi.Input<string>;

The ARN of the authorization

property region

region?: pulumi.Input<string>;

Region

interface ConfigurationAggregatorArgs

The set of arguments for constructing a ConfigurationAggregator resource.

property accountAggregationSource

accountAggregationSource?: pulumi.Input<{ ... }>;

The account(s) to aggregate config data from as documented below.

property name

name?: pulumi.Input<string>;

The name of the configuration aggregator.

property organizationAggregationSource

organizationAggregationSource?: pulumi.Input<{ ... }>;

The organization to aggregate config data from as documented below.

interface ConfigurationAggregatorState

Input properties used for looking up and filtering ConfigurationAggregator resources.

property accountAggregationSource

accountAggregationSource?: pulumi.Input<{ ... }>;

The account(s) to aggregate config data from as documented below.

property arn

arn?: pulumi.Input<string>;

The ARN of the aggregator

property name

name?: pulumi.Input<string>;

The name of the configuration aggregator.

property organizationAggregationSource

organizationAggregationSource?: pulumi.Input<{ ... }>;

The organization to aggregate config data from as documented below.

interface DeliveryChannelArgs

The set of arguments for constructing a DeliveryChannel resource.

property name

name?: pulumi.Input<string>;

The name of the delivery channel. Defaults to default. Changing it recreates the resource.

property s3BucketName

s3BucketName: pulumi.Input<string>;

The name of the S3 bucket used to store the configuration history.

property s3KeyPrefix

s3KeyPrefix?: pulumi.Input<string>;

The prefix for the specified S3 bucket.

property snapshotDeliveryProperties

snapshotDeliveryProperties?: pulumi.Input<{ ... }>;

Options for how AWS Config delivers configuration snapshots. See below

property snsTopicArn

snsTopicArn?: pulumi.Input<string>;

The ARN of the SNS topic that AWS Config delivers notifications to.

interface DeliveryChannelState

Input properties used for looking up and filtering DeliveryChannel resources.

property name

name?: pulumi.Input<string>;

The name of the delivery channel. Defaults to default. Changing it recreates the resource.

property s3BucketName

s3BucketName?: pulumi.Input<string>;

The name of the S3 bucket used to store the configuration history.

property s3KeyPrefix

s3KeyPrefix?: pulumi.Input<string>;

The prefix for the specified S3 bucket.

property snapshotDeliveryProperties

snapshotDeliveryProperties?: pulumi.Input<{ ... }>;

Options for how AWS Config delivers configuration snapshots. See below

property snsTopicArn

snsTopicArn?: pulumi.Input<string>;

The ARN of the SNS topic that AWS Config delivers notifications to.

interface RecorderArgs

The set of arguments for constructing a Recorder resource.

property name

name?: pulumi.Input<string>;

The name of the recorder. Defaults to default. Changing it recreates the resource.

property recordingGroup

recordingGroup?: pulumi.Input<{ ... }>;

Recording group - see below.

property roleArn

roleArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the IAM role. used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See AWS Docs for more details.

interface RecorderState

Input properties used for looking up and filtering Recorder resources.

property name

name?: pulumi.Input<string>;

The name of the recorder. Defaults to default. Changing it recreates the resource.

property recordingGroup

recordingGroup?: pulumi.Input<{ ... }>;

Recording group - see below.

property roleArn

roleArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the IAM role. used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See AWS Docs for more details.

interface RecorderStatusArgs

The set of arguments for constructing a RecorderStatus resource.

property isEnabled

isEnabled: pulumi.Input<boolean>;

Whether the configuration recorder should be enabled or disabled.

property name

name?: pulumi.Input<string>;

The name of the recorder

interface RecorderStatusState

Input properties used for looking up and filtering RecorderStatus resources.

property isEnabled

isEnabled?: pulumi.Input<boolean>;

Whether the configuration recorder should be enabled or disabled.

property name

name?: pulumi.Input<string>;

The name of the recorder

interface RuleArgs

The set of arguments for constructing a Rule resource.

property description

description?: pulumi.Input<string>;

Description of the rule

property inputParameters

inputParameters?: pulumi.Input<string>;

A string in JSON format that is passed to the AWS Config rule Lambda function.

property maximumExecutionFrequency

maximumExecutionFrequency?: pulumi.Input<string>;

The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If specified, requires message_type to be ScheduledNotification.

property name

name?: pulumi.Input<string>;

The name of the rule

property scope

scope?: pulumi.Input<{ ... }>;

Scope defines which resources can trigger an evaluation for the rule as documented below.

property source

source: pulumi.Input<{ ... }>;

Source specifies the rule owner, the rule identifier, and the notifications that cause the function to evaluate your AWS resources as documented below.

interface RuleState

Input properties used for looking up and filtering Rule resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the config rule

property description

description?: pulumi.Input<string>;

Description of the rule

property inputParameters

inputParameters?: pulumi.Input<string>;

A string in JSON format that is passed to the AWS Config rule Lambda function.

property maximumExecutionFrequency

maximumExecutionFrequency?: pulumi.Input<string>;

The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If specified, requires message_type to be ScheduledNotification.

property name

name?: pulumi.Input<string>;

The name of the rule

property ruleId

ruleId?: pulumi.Input<string>;

The ID of the config rule

property scope

scope?: pulumi.Input<{ ... }>;

Scope defines which resources can trigger an evaluation for the rule as documented below.

property source

source?: pulumi.Input<{ ... }>;

Source specifies the rule owner, the rule identifier, and the notifications that cause the function to evaluate your AWS resources as documented below.