1. Packages
  2. Lacework Provider
  3. API Docs
  4. IntegrationAwsCfg
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework

lacework.IntegrationAwsCfg

Explore with Pulumi AI

lacework logo
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework

    Use this resource to configure an AWS Config integration to analyze AWS configuration compliance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as lacework from "@pulumi/lacework";
    
    const accountAbc = new lacework.IntegrationAwsCfg("accountAbc", {credentials: {
        externalId: "12345",
        roleArn: "arn:aws:iam::1234567890:role/lacework_iam_example_role",
    }});
    
    import pulumi
    import pulumi_lacework as lacework
    
    account_abc = lacework.IntegrationAwsCfg("accountAbc", credentials={
        "external_id": "12345",
        "role_arn": "arn:aws:iam::1234567890:role/lacework_iam_example_role",
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lacework/v2/lacework"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lacework.NewIntegrationAwsCfg(ctx, "accountAbc", &lacework.IntegrationAwsCfgArgs{
    			Credentials: &lacework.IntegrationAwsCfgCredentialsArgs{
    				ExternalId: pulumi.String("12345"),
    				RoleArn:    pulumi.String("arn:aws:iam::1234567890:role/lacework_iam_example_role"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Lacework = Pulumi.Lacework;
    
    return await Deployment.RunAsync(() => 
    {
        var accountAbc = new Lacework.IntegrationAwsCfg("accountAbc", new()
        {
            Credentials = new Lacework.Inputs.IntegrationAwsCfgCredentialsArgs
            {
                ExternalId = "12345",
                RoleArn = "arn:aws:iam::1234567890:role/lacework_iam_example_role",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.lacework.IntegrationAwsCfg;
    import com.pulumi.lacework.IntegrationAwsCfgArgs;
    import com.pulumi.lacework.inputs.IntegrationAwsCfgCredentialsArgs;
    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 accountAbc = new IntegrationAwsCfg("accountAbc", IntegrationAwsCfgArgs.builder()
                .credentials(IntegrationAwsCfgCredentialsArgs.builder()
                    .externalId("12345")
                    .roleArn("arn:aws:iam::1234567890:role/lacework_iam_example_role")
                    .build())
                .build());
    
        }
    }
    
    resources:
      accountAbc:
        type: lacework:IntegrationAwsCfg
        properties:
          credentials:
            externalId: '12345'
            roleArn: arn:aws:iam::1234567890:role/lacework_iam_example_role
    

    Create IntegrationAwsCfg Resource

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

    Constructor syntax

    new IntegrationAwsCfg(name: string, args: IntegrationAwsCfgArgs, opts?: CustomResourceOptions);
    @overload
    def IntegrationAwsCfg(resource_name: str,
                          args: IntegrationAwsCfgArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def IntegrationAwsCfg(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          credentials: Optional[IntegrationAwsCfgCredentialsArgs] = None,
                          enabled: Optional[bool] = None,
                          integration_aws_cfg_id: Optional[str] = None,
                          name: Optional[str] = None,
                          retries: Optional[float] = None)
    func NewIntegrationAwsCfg(ctx *Context, name string, args IntegrationAwsCfgArgs, opts ...ResourceOption) (*IntegrationAwsCfg, error)
    public IntegrationAwsCfg(string name, IntegrationAwsCfgArgs args, CustomResourceOptions? opts = null)
    public IntegrationAwsCfg(String name, IntegrationAwsCfgArgs args)
    public IntegrationAwsCfg(String name, IntegrationAwsCfgArgs args, CustomResourceOptions options)
    
    type: lacework:IntegrationAwsCfg
    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 IntegrationAwsCfgArgs
    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 IntegrationAwsCfgArgs
    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 IntegrationAwsCfgArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationAwsCfgArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationAwsCfgArgs
    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 integrationAwsCfgResource = new Lacework.IntegrationAwsCfg("integrationAwsCfgResource", new()
    {
        Credentials = new Lacework.Inputs.IntegrationAwsCfgCredentialsArgs
        {
            ExternalId = "string",
            RoleArn = "string",
        },
        Enabled = false,
        IntegrationAwsCfgId = "string",
        Name = "string",
        Retries = 0,
    });
    
    example, err := lacework.NewIntegrationAwsCfg(ctx, "integrationAwsCfgResource", &lacework.IntegrationAwsCfgArgs{
    	Credentials: &lacework.IntegrationAwsCfgCredentialsArgs{
    		ExternalId: pulumi.String("string"),
    		RoleArn:    pulumi.String("string"),
    	},
    	Enabled:             pulumi.Bool(false),
    	IntegrationAwsCfgId: pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Retries:             pulumi.Float64(0),
    })
    
    var integrationAwsCfgResource = new IntegrationAwsCfg("integrationAwsCfgResource", IntegrationAwsCfgArgs.builder()
        .credentials(IntegrationAwsCfgCredentialsArgs.builder()
            .externalId("string")
            .roleArn("string")
            .build())
        .enabled(false)
        .integrationAwsCfgId("string")
        .name("string")
        .retries(0)
        .build());
    
    integration_aws_cfg_resource = lacework.IntegrationAwsCfg("integrationAwsCfgResource",
        credentials={
            "external_id": "string",
            "role_arn": "string",
        },
        enabled=False,
        integration_aws_cfg_id="string",
        name="string",
        retries=0)
    
    const integrationAwsCfgResource = new lacework.IntegrationAwsCfg("integrationAwsCfgResource", {
        credentials: {
            externalId: "string",
            roleArn: "string",
        },
        enabled: false,
        integrationAwsCfgId: "string",
        name: "string",
        retries: 0,
    });
    
    type: lacework:IntegrationAwsCfg
    properties:
        credentials:
            externalId: string
            roleArn: string
        enabled: false
        integrationAwsCfgId: string
        name: string
        retries: 0
    

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

    Credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    Enabled bool
    The state of the external integration. Defaults to true.
    IntegrationAwsCfgId string
    Name string
    The AWS Config integration name.
    Retries double
    The number of attempts to create the external integration. Defaults to 5.
    Credentials IntegrationAwsCfgCredentialsArgs
    The credentials needed by the integration. See Credentials below for details.
    Enabled bool
    The state of the external integration. Defaults to true.
    IntegrationAwsCfgId string
    Name string
    The AWS Config integration name.
    Retries float64
    The number of attempts to create the external integration. Defaults to 5.
    credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    enabled Boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId String
    name String
    The AWS Config integration name.
    retries Double
    The number of attempts to create the external integration. Defaults to 5.
    credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    enabled boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId string
    name string
    The AWS Config integration name.
    retries number
    The number of attempts to create the external integration. Defaults to 5.
    credentials IntegrationAwsCfgCredentialsArgs
    The credentials needed by the integration. See Credentials below for details.
    enabled bool
    The state of the external integration. Defaults to true.
    integration_aws_cfg_id str
    name str
    The AWS Config integration name.
    retries float
    The number of attempts to create the external integration. Defaults to 5.
    credentials Property Map
    The credentials needed by the integration. See Credentials below for details.
    enabled Boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId String
    name String
    The AWS Config integration name.
    retries Number
    The number of attempts to create the external integration. Defaults to 5.

    Outputs

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

    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    IntgGuid string
    OrgLevel bool
    TypeName string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    IntgGuid string
    OrgLevel bool
    TypeName string
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    id String
    The provider-assigned unique ID for this managed resource.
    intgGuid String
    orgLevel Boolean
    typeName String
    createdOrUpdatedBy string
    createdOrUpdatedTime string
    id string
    The provider-assigned unique ID for this managed resource.
    intgGuid string
    orgLevel boolean
    typeName string
    created_or_updated_by str
    created_or_updated_time str
    id str
    The provider-assigned unique ID for this managed resource.
    intg_guid str
    org_level bool
    type_name str
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    id String
    The provider-assigned unique ID for this managed resource.
    intgGuid String
    orgLevel Boolean
    typeName String

    Look up Existing IntegrationAwsCfg Resource

    Get an existing IntegrationAwsCfg 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?: IntegrationAwsCfgState, opts?: CustomResourceOptions): IntegrationAwsCfg
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_or_updated_by: Optional[str] = None,
            created_or_updated_time: Optional[str] = None,
            credentials: Optional[IntegrationAwsCfgCredentialsArgs] = None,
            enabled: Optional[bool] = None,
            integration_aws_cfg_id: Optional[str] = None,
            intg_guid: Optional[str] = None,
            name: Optional[str] = None,
            org_level: Optional[bool] = None,
            retries: Optional[float] = None,
            type_name: Optional[str] = None) -> IntegrationAwsCfg
    func GetIntegrationAwsCfg(ctx *Context, name string, id IDInput, state *IntegrationAwsCfgState, opts ...ResourceOption) (*IntegrationAwsCfg, error)
    public static IntegrationAwsCfg Get(string name, Input<string> id, IntegrationAwsCfgState? state, CustomResourceOptions? opts = null)
    public static IntegrationAwsCfg get(String name, Output<String> id, IntegrationAwsCfgState state, CustomResourceOptions options)
    resources:  _:    type: lacework:IntegrationAwsCfg    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    Enabled bool
    The state of the external integration. Defaults to true.
    IntegrationAwsCfgId string
    IntgGuid string
    Name string
    The AWS Config integration name.
    OrgLevel bool
    Retries double
    The number of attempts to create the external integration. Defaults to 5.
    TypeName string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Credentials IntegrationAwsCfgCredentialsArgs
    The credentials needed by the integration. See Credentials below for details.
    Enabled bool
    The state of the external integration. Defaults to true.
    IntegrationAwsCfgId string
    IntgGuid string
    Name string
    The AWS Config integration name.
    OrgLevel bool
    Retries float64
    The number of attempts to create the external integration. Defaults to 5.
    TypeName string
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    enabled Boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId String
    intgGuid String
    name String
    The AWS Config integration name.
    orgLevel Boolean
    retries Double
    The number of attempts to create the external integration. Defaults to 5.
    typeName String
    createdOrUpdatedBy string
    createdOrUpdatedTime string
    credentials IntegrationAwsCfgCredentials
    The credentials needed by the integration. See Credentials below for details.
    enabled boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId string
    intgGuid string
    name string
    The AWS Config integration name.
    orgLevel boolean
    retries number
    The number of attempts to create the external integration. Defaults to 5.
    typeName string
    created_or_updated_by str
    created_or_updated_time str
    credentials IntegrationAwsCfgCredentialsArgs
    The credentials needed by the integration. See Credentials below for details.
    enabled bool
    The state of the external integration. Defaults to true.
    integration_aws_cfg_id str
    intg_guid str
    name str
    The AWS Config integration name.
    org_level bool
    retries float
    The number of attempts to create the external integration. Defaults to 5.
    type_name str
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    credentials Property Map
    The credentials needed by the integration. See Credentials below for details.
    enabled Boolean
    The state of the external integration. Defaults to true.
    integrationAwsCfgId String
    intgGuid String
    name String
    The AWS Config integration name.
    orgLevel Boolean
    retries Number
    The number of attempts to create the external integration. Defaults to 5.
    typeName String

    Supporting Types

    IntegrationAwsCfgCredentials, IntegrationAwsCfgCredentialsArgs

    ExternalId string
    The external ID for the IAM role.
    RoleArn string
    The ARN of the IAM role.
    ExternalId string
    The external ID for the IAM role.
    RoleArn string
    The ARN of the IAM role.
    externalId String
    The external ID for the IAM role.
    roleArn String
    The ARN of the IAM role.
    externalId string
    The external ID for the IAM role.
    roleArn string
    The ARN of the IAM role.
    external_id str
    The external ID for the IAM role.
    role_arn str
    The ARN of the IAM role.
    externalId String
    The external ID for the IAM role.
    roleArn String
    The ARN of the IAM role.

    Import

    A Lacework AWS Config integration can be imported using a INT_GUID, e.g.

    $ pulumi import lacework:index/integrationAwsCfg:IntegrationAwsCfg account_abc EXAMPLE_1234BAE1E42182964D23973F44CFEA3C4AB63B99E9A1EC5
    

    -> Note: To retrieve the INT_GUID from existing integrations in your account, use the Lacework CLI command lacework cloud-account list. To install this tool follow this documentation.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    lacework lacework/terraform-provider-lacework
    License
    Notes
    This Pulumi package is based on the lacework Terraform Provider.
    lacework logo
    lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework