Module cfg

cfg

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.cfg.AggregateAuthorization(resource_name, opts=None, account_id=None, region=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an AWS Config Aggregate Authorization

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_id (pulumi.Input[str]) – Account ID
  • region (pulumi.Input[str]) – Region
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
account_id = None

Account ID

arn = None

The ARN of the authorization

region = None

Region

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, account_id=None, arn=None, region=None, tags=None)

Get an existing AggregateAuthorization resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] account_id: Account ID :param pulumi.Input[str] arn: The ARN of the authorization :param pulumi.Input[str] region: Region :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.cfg.ConfigurationAggregator(resource_name, opts=None, account_aggregation_source=None, name=None, organization_aggregation_source=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an AWS Config Configuration Aggregator

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_aggregation_source (pulumi.Input[dict]) – The account(s) to aggregate config data from as documented below.
  • name (pulumi.Input[str]) – The name of the configuration aggregator.
  • organization_aggregation_source (pulumi.Input[dict]) – The organization to aggregate config data from as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
account_aggregation_source = None

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

arn = None

The ARN of the aggregator

name = None

The name of the configuration aggregator.

organization_aggregation_source = None

The organization to aggregate config data from as documented below.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, account_aggregation_source=None, arn=None, name=None, organization_aggregation_source=None, tags=None)

Get an existing ConfigurationAggregator resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] account_aggregation_source: The account(s) to aggregate config data from as documented below. :param pulumi.Input[str] arn: The ARN of the aggregator :param pulumi.Input[str] name: The name of the configuration aggregator. :param pulumi.Input[dict] organization_aggregation_source: The organization to aggregate config data from as documented below. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.cfg.DeliveryChannel(resource_name, opts=None, name=None, s3_bucket_name=None, s3_key_prefix=None, snapshot_delivery_properties=None, sns_topic_arn=None, __props__=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the delivery channel. Defaults to default. Changing it recreates the resource.
  • s3_bucket_name (pulumi.Input[str]) – The name of the S3 bucket used to store the configuration history.
  • s3_key_prefix (pulumi.Input[str]) – The prefix for the specified S3 bucket.
  • snapshot_delivery_properties (pulumi.Input[dict]) – Options for how AWS Config delivers configuration snapshots. See below
  • sns_topic_arn (pulumi.Input[str]) – The ARN of the SNS topic that AWS Config delivers notifications to.
name = None

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

s3_bucket_name = None

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

s3_key_prefix = None

The prefix for the specified S3 bucket.

snapshot_delivery_properties = None

Options for how AWS Config delivers configuration snapshots. See below

sns_topic_arn = None

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

static get(resource_name, id, opts=None, name=None, s3_bucket_name=None, s3_key_prefix=None, snapshot_delivery_properties=None, sns_topic_arn=None)

Get an existing DeliveryChannel resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] name: The name of the delivery channel. Defaults to default. Changing it recreates the resource. :param pulumi.Input[str] s3_bucket_name: The name of the S3 bucket used to store the configuration history. :param pulumi.Input[str] s3_key_prefix: The prefix for the specified S3 bucket. :param pulumi.Input[dict] snapshot_delivery_properties: Options for how AWS Config delivers configuration snapshots. See below :param pulumi.Input[str] sns_topic_arn: The ARN of the SNS topic that AWS Config delivers notifications to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.cfg.Recorder(resource_name, opts=None, name=None, recording_group=None, role_arn=None, __props__=None, __name__=None, __opts__=None)

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 ``cfg.RecorderStatus` <https://www.terraform.io/docs/providers/aws/r/config_configuration_recorder_status.html>`_ is a separate resource.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the recorder. Defaults to default. Changing it recreates the resource.
  • recording_group (pulumi.Input[dict]) – Recording group - see below.
  • role_arn (pulumi.Input[str]) – 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.
name = None

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

recording_group = None

Recording group - see below.

role_arn = None

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.

static get(resource_name, id, opts=None, name=None, recording_group=None, role_arn=None)

Get an existing Recorder resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] name: The name of the recorder. Defaults to default. Changing it recreates the resource. :param pulumi.Input[dict] recording_group: Recording group - see below. :param pulumi.Input[str] role_arn: 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.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.cfg.RecorderStatus(resource_name, opts=None, is_enabled=None, name=None, __props__=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • is_enabled (pulumi.Input[bool]) – Whether the configuration recorder should be enabled or disabled.
  • name (pulumi.Input[str]) – The name of the recorder
is_enabled = None

Whether the configuration recorder should be enabled or disabled.

name = None

The name of the recorder

static get(resource_name, id, opts=None, is_enabled=None, name=None)

Get an existing RecorderStatus resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] is_enabled: Whether the configuration recorder should be enabled or disabled. :param pulumi.Input[str] name: The name of the recorder

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.cfg.Rule(resource_name, opts=None, description=None, input_parameters=None, maximum_execution_frequency=None, name=None, scope=None, source=None, tags=None, __props__=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – Description of the rule
  • input_parameters (pulumi.Input[str]) – A string in JSON format that is passed to the AWS Config rule Lambda function.
  • maximum_execution_frequency (pulumi.Input[str]) – 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.
  • name (pulumi.Input[str]) – The name of the rule
  • scope (pulumi.Input[dict]) – Scope defines which resources can trigger an evaluation for the rule as documented below.
  • source (pulumi.Input[dict]) – Source specifies the rule owner, the rule identifier, and the notifications that cause the function to evaluate your AWS resources as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the config rule

description = None

Description of the rule

input_parameters = None

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

maximum_execution_frequency = None

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.

name = None

The name of the rule

rule_id = None

The ID of the config rule

scope = None

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

source = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, description=None, input_parameters=None, maximum_execution_frequency=None, name=None, rule_id=None, scope=None, source=None, tags=None)

Get an existing Rule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] arn: The ARN of the config rule :param pulumi.Input[str] description: Description of the rule :param pulumi.Input[str] input_parameters: A string in JSON format that is passed to the AWS Config rule Lambda function. :param pulumi.Input[str] maximum_execution_frequency: 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.
Parameters:
  • name (pulumi.Input[str]) – The name of the rule
  • rule_id (pulumi.Input[str]) – The ID of the config rule
  • scope (pulumi.Input[dict]) – Scope defines which resources can trigger an evaluation for the rule as documented below.
  • source (pulumi.Input[dict]) – Source specifies the rule owner, the rule identifier, and the notifications that cause the function to evaluate your AWS resources as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str