Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. configuration
  5. ConformancePack

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.configuration.ConformancePack

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var conformancePack = new AwsNative.Configuration.ConformancePack("conformancePack", new()
    {
        ConformancePackName = "ConformancePackName",
        DeliveryS3Bucket = "DeliveryS3Bucket",
        TemplateS3Uri = "s3://bucketname/prefix",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/configuration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := configuration.NewConformancePack(ctx, "conformancePack", &configuration.ConformancePackArgs{
			ConformancePackName: pulumi.String("ConformancePackName"),
			DeliveryS3Bucket:    pulumi.String("DeliveryS3Bucket"),
			TemplateS3Uri:       pulumi.String("s3://bucketname/prefix"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

conformance_pack = aws_native.configuration.ConformancePack("conformancePack",
    conformance_pack_name="ConformancePackName",
    delivery_s3_bucket="DeliveryS3Bucket",
    template_s3_uri="s3://bucketname/prefix")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const conformancePack = new aws_native.configuration.ConformancePack("conformancePack", {
    conformancePackName: "ConformancePackName",
    deliveryS3Bucket: "DeliveryS3Bucket",
    templateS3Uri: "s3://bucketname/prefix",
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var cloudFormationCanaryPack = new AwsNative.Configuration.ConformancePack("cloudFormationCanaryPack", new()
    {
        ConformancePackName = "ConformancePackName",
        DeliveryS3Bucket = "DeliveryS3Bucket",
        TemplateS3Uri = "s3://bucketname/prefix",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/configuration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := configuration.NewConformancePack(ctx, "cloudFormationCanaryPack", &configuration.ConformancePackArgs{
			ConformancePackName: pulumi.String("ConformancePackName"),
			DeliveryS3Bucket:    pulumi.String("DeliveryS3Bucket"),
			TemplateS3Uri:       pulumi.String("s3://bucketname/prefix"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

cloud_formation_canary_pack = aws_native.configuration.ConformancePack("cloudFormationCanaryPack",
    conformance_pack_name="ConformancePackName",
    delivery_s3_bucket="DeliveryS3Bucket",
    template_s3_uri="s3://bucketname/prefix")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const cloudFormationCanaryPack = new aws_native.configuration.ConformancePack("cloudFormationCanaryPack", {
    conformancePackName: "ConformancePackName",
    deliveryS3Bucket: "DeliveryS3Bucket",
    templateS3Uri: "s3://bucketname/prefix",
});

    Coming soon!

    Create ConformancePack Resource

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

    Constructor syntax

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

@overload
def ConformancePack(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    conformance_pack_input_parameters: Optional[Sequence[ConformancePackInputParameterArgs]] = None,
                    conformance_pack_name: Optional[str] = None,
                    delivery_s3_bucket: Optional[str] = None,
                    delivery_s3_key_prefix: Optional[str] = None,
                    template_body: Optional[str] = None,
                    template_s3_uri: Optional[str] = None,
                    template_ssm_document_details: Optional[TemplateSsmDocumentDetailsPropertiesArgs] = None)
    func NewConformancePack(ctx *Context, name string, args *ConformancePackArgs, opts ...ResourceOption) (*ConformancePack, error)
    public ConformancePack(string name, ConformancePackArgs? args = null, CustomResourceOptions? opts = null)
    public ConformancePack(String name, ConformancePackArgs args)
public ConformancePack(String name, ConformancePackArgs args, CustomResourceOptions options)

    type: aws-native:configuration:ConformancePack
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 ConformancePackArgs
    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 ConformancePackArgs
    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 ConformancePackArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConformancePackArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConformancePackArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ConformancePackInputParameters List<Pulumi.AwsNative.Configuration.Inputs.ConformancePackInputParameter>
    A list of ConformancePackInputParameter objects.
    ConformancePackName string
    Name of the conformance pack which will be assigned as the unique identifier.
    DeliveryS3Bucket string
    AWS Config stores intermediate files while processing conformance pack template.
    DeliveryS3KeyPrefix string
    The prefix for delivery S3 bucket.
    TemplateBody string
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    TemplateS3Uri string
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    TemplateSsmDocumentDetails Pulumi.AwsNative.Configuration.Inputs.TemplateSsmDocumentDetailsProperties
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
    ConformancePackInputParameters []ConformancePackInputParameterArgs
    A list of ConformancePackInputParameter objects.
    ConformancePackName string
    Name of the conformance pack which will be assigned as the unique identifier.
    DeliveryS3Bucket string
    AWS Config stores intermediate files while processing conformance pack template.
    DeliveryS3KeyPrefix string
    The prefix for delivery S3 bucket.
    TemplateBody string
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    TemplateS3Uri string
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    TemplateSsmDocumentDetails TemplateSsmDocumentDetailsPropertiesArgs
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
    conformancePackInputParameters List<ConformancePackInputParameter>
    A list of ConformancePackInputParameter objects.
    conformancePackName String
    Name of the conformance pack which will be assigned as the unique identifier.
    deliveryS3Bucket String
    AWS Config stores intermediate files while processing conformance pack template.
    deliveryS3KeyPrefix String
    The prefix for delivery S3 bucket.
    templateBody String
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    templateS3Uri String
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    templateSsmDocumentDetails TemplateSsmDocumentDetailsProperties
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
    conformancePackInputParameters ConformancePackInputParameter[]
    A list of ConformancePackInputParameter objects.
    conformancePackName string
    Name of the conformance pack which will be assigned as the unique identifier.
    deliveryS3Bucket string
    AWS Config stores intermediate files while processing conformance pack template.
    deliveryS3KeyPrefix string
    The prefix for delivery S3 bucket.
    templateBody string
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    templateS3Uri string
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    templateSsmDocumentDetails TemplateSsmDocumentDetailsProperties
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
    conformance_pack_input_parameters Sequence[ConformancePackInputParameterArgs]
    A list of ConformancePackInputParameter objects.
    conformance_pack_name str
    Name of the conformance pack which will be assigned as the unique identifier.
    delivery_s3_bucket str
    AWS Config stores intermediate files while processing conformance pack template.
    delivery_s3_key_prefix str
    The prefix for delivery S3 bucket.
    template_body str
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    template_s3_uri str
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    template_ssm_document_details TemplateSsmDocumentDetailsPropertiesArgs
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
    conformancePackInputParameters List<Property Map>
    A list of ConformancePackInputParameter objects.
    conformancePackName String
    Name of the conformance pack which will be assigned as the unique identifier.
    deliveryS3Bucket String
    AWS Config stores intermediate files while processing conformance pack template.
    deliveryS3KeyPrefix String
    The prefix for delivery S3 bucket.
    templateBody String
    A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
    templateS3Uri String
    Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
    templateSsmDocumentDetails Property Map
    The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

    Outputs

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

    Supporting Types

    ConformancePackInputParameter, ConformancePackInputParameterArgs

    ParameterName string
    One part of a key-value pair.
    ParameterValue string
    Another part of the key-value pair.
    ParameterName string
    One part of a key-value pair.
    ParameterValue string
    Another part of the key-value pair.
    parameterName String
    One part of a key-value pair.
    parameterValue String
    Another part of the key-value pair.
    parameterName string
    One part of a key-value pair.
    parameterValue string
    Another part of the key-value pair.
    parameter_name str
    One part of a key-value pair.
    parameter_value str
    Another part of the key-value pair.
    parameterName String
    One part of a key-value pair.
    parameterValue String
    Another part of the key-value pair.

    TemplateSsmDocumentDetailsProperties, TemplateSsmDocumentDetailsPropertiesArgs

    DocumentName string
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    DocumentVersion string

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    DocumentName string
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    DocumentVersion string

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    documentName String
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    documentVersion String

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    documentName string
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    documentVersion string

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    document_name str
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    document_version str

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    documentName String
    The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
    documentVersion String

    The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.

    This field is optional.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native