1. Packages
  2. AWS
  3. API Docs
  4. cfg
  5. ConformancePack
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.cfg.ConformancePack

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages a Config Conformance Pack. More information about this collection of Config rules and remediation actions can be found in the Conformance Packs documentation. Sample Conformance Pack templates may be found in the AWS Config Rules Repository.

    NOTE: The account must have a Configuration Recorder with proper IAM permissions before the Conformance Pack will successfully create or update. See also the aws.cfg.Recorder resource.

    Example Usage

    Template Body

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.cfg.ConformancePack("example", {
        name: "example",
        inputParameters: [{
            parameterName: "AccessKeysRotatedParameterMaxAccessKeyAge",
            parameterValue: "90",
        }],
        templateBody: `Parameters:
      AccessKeysRotatedParameterMaxAccessKeyAge:
        Type: String
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    `,
    }, {
        dependsOn: [exampleAwsConfigConfigurationRecorder],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.cfg.ConformancePack("example",
        name="example",
        input_parameters=[{
            "parameter_name": "AccessKeysRotatedParameterMaxAccessKeyAge",
            "parameter_value": "90",
        }],
        template_body="""Parameters:
      AccessKeysRotatedParameterMaxAccessKeyAge:
        Type: String
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    """,
        opts = pulumi.ResourceOptions(depends_on=[example_aws_config_configuration_recorder]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cfg"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cfg.NewConformancePack(ctx, "example", &cfg.ConformancePackArgs{
    			Name: pulumi.String("example"),
    			InputParameters: cfg.ConformancePackInputParameterArray{
    				&cfg.ConformancePackInputParameterArgs{
    					ParameterName:  pulumi.String("AccessKeysRotatedParameterMaxAccessKeyAge"),
    					ParameterValue: pulumi.String("90"),
    				},
    			},
    			TemplateBody: pulumi.String(`Parameters:
      AccessKeysRotatedParameterMaxAccessKeyAge:
        Type: String
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    `),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleAwsConfigConfigurationRecorder,
    		}))
    		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.Cfg.ConformancePack("example", new()
        {
            Name = "example",
            InputParameters = new[]
            {
                new Aws.Cfg.Inputs.ConformancePackInputParameterArgs
                {
                    ParameterName = "AccessKeysRotatedParameterMaxAccessKeyAge",
                    ParameterValue = "90",
                },
            },
            TemplateBody = @"Parameters:
      AccessKeysRotatedParameterMaxAccessKeyAge:
        Type: String
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    ",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleAwsConfigConfigurationRecorder,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cfg.ConformancePack;
    import com.pulumi.aws.cfg.ConformancePackArgs;
    import com.pulumi.aws.cfg.inputs.ConformancePackInputParameterArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 ConformancePack("example", ConformancePackArgs.builder()
                .name("example")
                .inputParameters(ConformancePackInputParameterArgs.builder()
                    .parameterName("AccessKeysRotatedParameterMaxAccessKeyAge")
                    .parameterValue("90")
                    .build())
                .templateBody("""
    Parameters:
      AccessKeysRotatedParameterMaxAccessKeyAge:
        Type: String
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
                """)
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleAwsConfigConfigurationRecorder)
                    .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cfg:ConformancePack
        properties:
          name: example
          inputParameters:
            - parameterName: AccessKeysRotatedParameterMaxAccessKeyAge
              parameterValue: '90'
          templateBody: |
            Parameters:
              AccessKeysRotatedParameterMaxAccessKeyAge:
                Type: String
            Resources:
              IAMPasswordPolicy:
                Properties:
                  ConfigRuleName: IAMPasswordPolicy
                  Source:
                    Owner: AWS
                    SourceIdentifier: IAM_PASSWORD_POLICY
                Type: AWS::Config::ConfigRule        
        options:
          dependson:
            - ${exampleAwsConfigConfigurationRecorder}
    

    Template S3 URI

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const exampleBucketV2 = new aws.s3.BucketV2("example", {bucket: "example"});
    const exampleBucketObjectv2 = new aws.s3.BucketObjectv2("example", {
        bucket: exampleBucketV2.id,
        key: "example-key",
        content: `Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    `,
    });
    const example = new aws.cfg.ConformancePack("example", {
        name: "example",
        templateS3Uri: pulumi.interpolate`s3://${exampleBucketV2.bucket}/${exampleBucketObjectv2.key}`,
    }, {
        dependsOn: [exampleAwsConfigConfigurationRecorder],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example_bucket_v2 = aws.s3.BucketV2("example", bucket="example")
    example_bucket_objectv2 = aws.s3.BucketObjectv2("example",
        bucket=example_bucket_v2.id,
        key="example-key",
        content="""Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    """)
    example = aws.cfg.ConformancePack("example",
        name="example",
        template_s3_uri=pulumi.Output.all(
            bucket=example_bucket_v2.bucket,
            key=example_bucket_objectv2.key
    ).apply(lambda resolved_outputs: f"s3://{resolved_outputs['bucket']}/{resolved_outputs['key']}")
    ,
        opts = pulumi.ResourceOptions(depends_on=[example_aws_config_configuration_recorder]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cfg"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleBucketV2, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
    			Bucket: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleBucketObjectv2, err := s3.NewBucketObjectv2(ctx, "example", &s3.BucketObjectv2Args{
    			Bucket: exampleBucketV2.ID(),
    			Key:    pulumi.String("example-key"),
    			Content: pulumi.String(`Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    `),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cfg.NewConformancePack(ctx, "example", &cfg.ConformancePackArgs{
    			Name: pulumi.String("example"),
    			TemplateS3Uri: pulumi.All(exampleBucketV2.Bucket, exampleBucketObjectv2.Key).ApplyT(func(_args []interface{}) (string, error) {
    				bucket := _args[0].(string)
    				key := _args[1].(string)
    				return fmt.Sprintf("s3://%v/%v", bucket, key), nil
    			}).(pulumi.StringOutput),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleAwsConfigConfigurationRecorder,
    		}))
    		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 exampleBucketV2 = new Aws.S3.BucketV2("example", new()
        {
            Bucket = "example",
        });
    
        var exampleBucketObjectv2 = new Aws.S3.BucketObjectv2("example", new()
        {
            Bucket = exampleBucketV2.Id,
            Key = "example-key",
            Content = @"Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
    ",
        });
    
        var example = new Aws.Cfg.ConformancePack("example", new()
        {
            Name = "example",
            TemplateS3Uri = Output.Tuple(exampleBucketV2.Bucket, exampleBucketObjectv2.Key).Apply(values =>
            {
                var bucket = values.Item1;
                var key = values.Item2;
                return $"s3://{bucket}/{key}";
            }),
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleAwsConfigConfigurationRecorder,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketV2;
    import com.pulumi.aws.s3.BucketV2Args;
    import com.pulumi.aws.s3.BucketObjectv2;
    import com.pulumi.aws.s3.BucketObjectv2Args;
    import com.pulumi.aws.cfg.ConformancePack;
    import com.pulumi.aws.cfg.ConformancePackArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 exampleBucketV2 = new BucketV2("exampleBucketV2", BucketV2Args.builder()
                .bucket("example")
                .build());
    
            var exampleBucketObjectv2 = new BucketObjectv2("exampleBucketObjectv2", BucketObjectv2Args.builder()
                .bucket(exampleBucketV2.id())
                .key("example-key")
                .content("""
    Resources:
      IAMPasswordPolicy:
        Properties:
          ConfigRuleName: IAMPasswordPolicy
          Source:
            Owner: AWS
            SourceIdentifier: IAM_PASSWORD_POLICY
        Type: AWS::Config::ConfigRule
                """)
                .build());
    
            var example = new ConformancePack("example", ConformancePackArgs.builder()
                .name("example")
                .templateS3Uri(Output.tuple(exampleBucketV2.bucket(), exampleBucketObjectv2.key()).applyValue(values -> {
                    var bucket = values.t1;
                    var key = values.t2;
                    return String.format("s3://%s/%s", bucket,key);
                }))
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleAwsConfigConfigurationRecorder)
                    .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cfg:ConformancePack
        properties:
          name: example
          templateS3Uri: s3://${exampleBucketV2.bucket}/${exampleBucketObjectv2.key}
        options:
          dependson:
            - ${exampleAwsConfigConfigurationRecorder}
      exampleBucketV2:
        type: aws:s3:BucketV2
        name: example
        properties:
          bucket: example
      exampleBucketObjectv2:
        type: aws:s3:BucketObjectv2
        name: example
        properties:
          bucket: ${exampleBucketV2.id}
          key: example-key
          content: |
            Resources:
              IAMPasswordPolicy:
                Properties:
                  ConfigRuleName: IAMPasswordPolicy
                  Source:
                    Owner: AWS
                    SourceIdentifier: IAM_PASSWORD_POLICY
                Type: AWS::Config::ConfigRule        
    

    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,
                        delivery_s3_bucket: Optional[str] = None,
                        delivery_s3_key_prefix: Optional[str] = None,
                        input_parameters: Optional[Sequence[ConformancePackInputParameterArgs]] = None,
                        name: Optional[str] = None,
                        template_body: Optional[str] = None,
                        template_s3_uri: Optional[str] = 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:cfg: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var conformancePackResource = new Aws.Cfg.ConformancePack("conformancePackResource", new()
    {
        DeliveryS3Bucket = "string",
        DeliveryS3KeyPrefix = "string",
        InputParameters = new[]
        {
            new Aws.Cfg.Inputs.ConformancePackInputParameterArgs
            {
                ParameterName = "string",
                ParameterValue = "string",
            },
        },
        Name = "string",
        TemplateBody = "string",
        TemplateS3Uri = "string",
    });
    
    example, err := cfg.NewConformancePack(ctx, "conformancePackResource", &cfg.ConformancePackArgs{
    	DeliveryS3Bucket:    pulumi.String("string"),
    	DeliveryS3KeyPrefix: pulumi.String("string"),
    	InputParameters: cfg.ConformancePackInputParameterArray{
    		&cfg.ConformancePackInputParameterArgs{
    			ParameterName:  pulumi.String("string"),
    			ParameterValue: pulumi.String("string"),
    		},
    	},
    	Name:          pulumi.String("string"),
    	TemplateBody:  pulumi.String("string"),
    	TemplateS3Uri: pulumi.String("string"),
    })
    
    var conformancePackResource = new ConformancePack("conformancePackResource", ConformancePackArgs.builder()
        .deliveryS3Bucket("string")
        .deliveryS3KeyPrefix("string")
        .inputParameters(ConformancePackInputParameterArgs.builder()
            .parameterName("string")
            .parameterValue("string")
            .build())
        .name("string")
        .templateBody("string")
        .templateS3Uri("string")
        .build());
    
    conformance_pack_resource = aws.cfg.ConformancePack("conformancePackResource",
        delivery_s3_bucket="string",
        delivery_s3_key_prefix="string",
        input_parameters=[{
            "parameter_name": "string",
            "parameter_value": "string",
        }],
        name="string",
        template_body="string",
        template_s3_uri="string")
    
    const conformancePackResource = new aws.cfg.ConformancePack("conformancePackResource", {
        deliveryS3Bucket: "string",
        deliveryS3KeyPrefix: "string",
        inputParameters: [{
            parameterName: "string",
            parameterValue: "string",
        }],
        name: "string",
        templateBody: "string",
        templateS3Uri: "string",
    });
    
    type: aws:cfg:ConformancePack
    properties:
        deliveryS3Bucket: string
        deliveryS3KeyPrefix: string
        inputParameters:
            - parameterName: string
              parameterValue: string
        name: string
        templateBody: string
        templateS3Uri: string
    

    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:

    DeliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    DeliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    InputParameters List<ConformancePackInputParameter>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    Name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    TemplateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    TemplateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    DeliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    DeliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    InputParameters []ConformancePackInputParameterArgs
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    Name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    TemplateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    TemplateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    deliveryS3Bucket String
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix String
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters List<ConformancePackInputParameter>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name String
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody String
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri String
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    deliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters ConformancePackInputParameter[]
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    delivery_s3_bucket str
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    delivery_s3_key_prefix str
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    input_parameters Sequence[ConformancePackInputParameterArgs]
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name str
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    template_body str
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    template_s3_uri str
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    deliveryS3Bucket String
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix String
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters List<Property Map>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name String
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody String
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri String
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) of the conformance pack.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Amazon Resource Name (ARN) of the conformance pack.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Resource Name (ARN) of the conformance pack.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Amazon Resource Name (ARN) of the conformance pack.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Amazon Resource Name (ARN) of the conformance pack.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Resource Name (ARN) of the conformance pack.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConformancePack Resource

    Get an existing ConformancePack 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?: ConformancePackState, opts?: CustomResourceOptions): ConformancePack
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            delivery_s3_bucket: Optional[str] = None,
            delivery_s3_key_prefix: Optional[str] = None,
            input_parameters: Optional[Sequence[ConformancePackInputParameterArgs]] = None,
            name: Optional[str] = None,
            template_body: Optional[str] = None,
            template_s3_uri: Optional[str] = None) -> ConformancePack
    func GetConformancePack(ctx *Context, name string, id IDInput, state *ConformancePackState, opts ...ResourceOption) (*ConformancePack, error)
    public static ConformancePack Get(string name, Input<string> id, ConformancePackState? state, CustomResourceOptions? opts = null)
    public static ConformancePack get(String name, Output<String> id, ConformancePackState 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:
    Arn string
    Amazon Resource Name (ARN) of the conformance pack.
    DeliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    DeliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    InputParameters List<ConformancePackInputParameter>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    Name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    TemplateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    TemplateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    Arn string
    Amazon Resource Name (ARN) of the conformance pack.
    DeliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    DeliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    InputParameters []ConformancePackInputParameterArgs
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    Name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    TemplateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    TemplateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    arn String
    Amazon Resource Name (ARN) of the conformance pack.
    deliveryS3Bucket String
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix String
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters List<ConformancePackInputParameter>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name String
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody String
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri String
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    arn string
    Amazon Resource Name (ARN) of the conformance pack.
    deliveryS3Bucket string
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix string
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters ConformancePackInputParameter[]
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name string
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody string
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri string
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    arn str
    Amazon Resource Name (ARN) of the conformance pack.
    delivery_s3_bucket str
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    delivery_s3_key_prefix str
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    input_parameters Sequence[ConformancePackInputParameterArgs]
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name str
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    template_body str
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    template_s3_uri str
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
    arn String
    Amazon Resource Name (ARN) of the conformance pack.
    deliveryS3Bucket String
    Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63.
    deliveryS3KeyPrefix String
    The prefix for the Amazon S3 bucket. Maximum length of 1024.
    inputParameters List<Property Map>
    Set of configuration blocks describing input parameters passed to the conformance pack template. Documented below. When configured, the parameters must also be included in the template_body or in the template stored in Amazon S3 if using template_s3_uri.
    name String
    The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
    templateBody String
    A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
    templateS3Uri String
    Location of file, e.g., s3://bucketname/prefix, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.

    Supporting Types

    ConformancePackInputParameter, ConformancePackInputParameterArgs

    ParameterName string
    The input key.
    ParameterValue string
    The input value.
    ParameterName string
    The input key.
    ParameterValue string
    The input value.
    parameterName String
    The input key.
    parameterValue String
    The input value.
    parameterName string
    The input key.
    parameterValue string
    The input value.
    parameter_name str
    The input key.
    parameter_value str
    The input value.
    parameterName String
    The input key.
    parameterValue String
    The input value.

    Import

    Using pulumi import, import Config Conformance Packs using the name. For example:

    $ pulumi import aws:cfg/conformancePack:ConformancePack example example
    

    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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi