Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ssm
  5. ResourceDataSync

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssm.ResourceDataSync

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SSM::ResourceDataSync

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncToDestination",
        S3Destination = new AwsNative.Ssm.Inputs.ResourceDataSyncS3DestinationArgs
        {
            BucketName = "test-bucket",
            BucketRegion = "us-east-2",
            SyncFormat = "JsonSerDe",
            BucketPrefix = "cfn",
            KmsKeyArn = "kmsKeyARN",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncToDestination"),
			S3Destination: &ssm.ResourceDataSyncS3DestinationArgs{
				BucketName:   pulumi.String("test-bucket"),
				BucketRegion: pulumi.String("us-east-2"),
				SyncFormat:   pulumi.String("JsonSerDe"),
				BucketPrefix: pulumi.String("cfn"),
				KmsKeyArn:    pulumi.String("kmsKeyARN"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncToDestination",
    s3_destination={
        "bucket_name": "test-bucket",
        "bucket_region": "us-east-2",
        "sync_format": "JsonSerDe",
        "bucket_prefix": "cfn",
        "kms_key_arn": "kmsKeyARN",
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncToDestination",
    s3Destination: {
        bucketName: "test-bucket",
        bucketRegion: "us-east-2",
        syncFormat: "JsonSerDe",
        bucketPrefix: "cfn",
        kmsKeyArn: "kmsKeyARN",
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncToDestination",
        S3Destination = new AwsNative.Ssm.Inputs.ResourceDataSyncS3DestinationArgs
        {
            BucketName = "test-bucket",
            BucketRegion = "us-east-2",
            SyncFormat = "JsonSerDe",
            BucketPrefix = "cfn",
            KmsKeyArn = "kmsKeyARN",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncToDestination"),
			S3Destination: &ssm.ResourceDataSyncS3DestinationArgs{
				BucketName:   pulumi.String("test-bucket"),
				BucketRegion: pulumi.String("us-east-2"),
				SyncFormat:   pulumi.String("JsonSerDe"),
				BucketPrefix: pulumi.String("cfn"),
				KmsKeyArn:    pulumi.String("kmsKeyARN"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncToDestination",
    s3_destination={
        "bucket_name": "test-bucket",
        "bucket_region": "us-east-2",
        "sync_format": "JsonSerDe",
        "bucket_prefix": "cfn",
        "kms_key_arn": "kmsKeyARN",
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncToDestination",
    s3Destination: {
        bucketName: "test-bucket",
        bucketRegion: "us-east-2",
        syncFormat: "JsonSerDe",
        bucketPrefix: "cfn",
        kmsKeyArn: "kmsKeyARN",
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "SingleAccountMultiRegions",
            SourceRegions = new[]
            {
                "us-east-1",
                "us-west-1",
                "us-west-2",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("SingleAccountMultiRegions"),
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-east-1"),
					pulumi.String("us-west-1"),
					pulumi.String("us-west-2"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "SingleAccountMultiRegions",
        "source_regions": [
            "us-east-1",
            "us-west-1",
            "us-west-2",
        ],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "SingleAccountMultiRegions",
        sourceRegions: [
            "us-east-1",
            "us-west-1",
            "us-west-2",
        ],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "SingleAccountMultiRegions",
            SourceRegions = new[]
            {
                "us-east-1",
                "us-west-1",
                "us-west-2",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("SingleAccountMultiRegions"),
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-east-1"),
					pulumi.String("us-west-1"),
					pulumi.String("us-west-2"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "SingleAccountMultiRegions",
        "source_regions": [
            "us-east-1",
            "us-west-1",
            "us-west-2",
        ],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "SingleAccountMultiRegions",
        sourceRegions: [
            "us-east-1",
            "us-west-1",
            "us-west-2",
        ],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "AwsOrganizations",
            AwsOrganizationsSource = new AwsNative.Ssm.Inputs.ResourceDataSyncAwsOrganizationsSourceArgs
            {
                OrganizationSourceType = "EntireOrganization",
            },
            SourceRegions = new[]
            {
                "us-west-1",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("AwsOrganizations"),
				AwsOrganizationsSource: &ssm.ResourceDataSyncAwsOrganizationsSourceArgs{
					OrganizationSourceType: pulumi.String("EntireOrganization"),
				},
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-west-1"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "AwsOrganizations",
        "aws_organizations_source": {
            "organization_source_type": "EntireOrganization",
        },
        "source_regions": ["us-west-1"],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "AwsOrganizations",
        awsOrganizationsSource: {
            organizationSourceType: "EntireOrganization",
        },
        sourceRegions: ["us-west-1"],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "AwsOrganizations",
            AwsOrganizationsSource = new AwsNative.Ssm.Inputs.ResourceDataSyncAwsOrganizationsSourceArgs
            {
                OrganizationSourceType = "EntireOrganization",
            },
            SourceRegions = new[]
            {
                "us-west-1",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("AwsOrganizations"),
				AwsOrganizationsSource: &ssm.ResourceDataSyncAwsOrganizationsSourceArgs{
					OrganizationSourceType: pulumi.String("EntireOrganization"),
				},
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-west-1"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "AwsOrganizations",
        "aws_organizations_source": {
            "organization_source_type": "EntireOrganization",
        },
        "source_regions": ["us-west-1"],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "AwsOrganizations",
        awsOrganizationsSource: {
            organizationSourceType: "EntireOrganization",
        },
        sourceRegions: ["us-west-1"],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "AwsOrganizations",
            AwsOrganizationsSource = new AwsNative.Ssm.Inputs.ResourceDataSyncAwsOrganizationsSourceArgs
            {
                OrganizationSourceType = "OrganizationalUnits",
                OrganizationalUnits = new[]
                {
                    "ou-12345",
                },
            },
            SourceRegions = new[]
            {
                "us-west-1",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("AwsOrganizations"),
				AwsOrganizationsSource: &ssm.ResourceDataSyncAwsOrganizationsSourceArgs{
					OrganizationSourceType: pulumi.String("OrganizationalUnits"),
					OrganizationalUnits: pulumi.StringArray{
						pulumi.String("ou-12345"),
					},
				},
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-west-1"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "AwsOrganizations",
        "aws_organizations_source": {
            "organization_source_type": "OrganizationalUnits",
            "organizational_units": ["ou-12345"],
        },
        "source_regions": ["us-west-1"],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "AwsOrganizations",
        awsOrganizationsSource: {
            organizationSourceType: "OrganizationalUnits",
            organizationalUnits: ["ou-12345"],
        },
        sourceRegions: ["us-west-1"],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicResourceDataSync = new AwsNative.Ssm.ResourceDataSync("basicResourceDataSync", new()
    {
        SyncName = "test-sync",
        SyncType = "SyncFromSource",
        SyncSource = new AwsNative.Ssm.Inputs.ResourceDataSyncSyncSourceArgs
        {
            SourceType = "AwsOrganizations",
            AwsOrganizationsSource = new AwsNative.Ssm.Inputs.ResourceDataSyncAwsOrganizationsSourceArgs
            {
                OrganizationSourceType = "OrganizationalUnits",
                OrganizationalUnits = new[]
                {
                    "ou-12345",
                },
            },
            SourceRegions = new[]
            {
                "us-west-1",
            },
            IncludeFutureRegions = false,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewResourceDataSync(ctx, "basicResourceDataSync", &ssm.ResourceDataSyncArgs{
			SyncName: pulumi.String("test-sync"),
			SyncType: pulumi.String("SyncFromSource"),
			SyncSource: &ssm.ResourceDataSyncSyncSourceArgs{
				SourceType: pulumi.String("AwsOrganizations"),
				AwsOrganizationsSource: &ssm.ResourceDataSyncAwsOrganizationsSourceArgs{
					OrganizationSourceType: pulumi.String("OrganizationalUnits"),
					OrganizationalUnits: pulumi.StringArray{
						pulumi.String("ou-12345"),
					},
				},
				SourceRegions: pulumi.StringArray{
					pulumi.String("us-west-1"),
				},
				IncludeFutureRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_resource_data_sync = aws_native.ssm.ResourceDataSync("basicResourceDataSync",
    sync_name="test-sync",
    sync_type="SyncFromSource",
    sync_source={
        "source_type": "AwsOrganizations",
        "aws_organizations_source": {
            "organization_source_type": "OrganizationalUnits",
            "organizational_units": ["ou-12345"],
        },
        "source_regions": ["us-west-1"],
        "include_future_regions": False,
    })

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

const basicResourceDataSync = new aws_native.ssm.ResourceDataSync("basicResourceDataSync", {
    syncName: "test-sync",
    syncType: "SyncFromSource",
    syncSource: {
        sourceType: "AwsOrganizations",
        awsOrganizationsSource: {
            organizationSourceType: "OrganizationalUnits",
            organizationalUnits: ["ou-12345"],
        },
        sourceRegions: ["us-west-1"],
        includeFutureRegions: false,
    },
});

    Coming soon!

    Create ResourceDataSync Resource

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

    Constructor syntax

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

@overload
def ResourceDataSync(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket_name: Optional[str] = None,
                     bucket_prefix: Optional[str] = None,
                     bucket_region: Optional[str] = None,
                     kms_key_arn: Optional[str] = None,
                     s3_destination: Optional[ResourceDataSyncS3DestinationArgs] = None,
                     sync_format: Optional[str] = None,
                     sync_name: Optional[str] = None,
                     sync_source: Optional[ResourceDataSyncSyncSourceArgs] = None,
                     sync_type: Optional[str] = None)
    func NewResourceDataSync(ctx *Context, name string, args *ResourceDataSyncArgs, opts ...ResourceOption) (*ResourceDataSync, error)
    public ResourceDataSync(string name, ResourceDataSyncArgs? args = null, CustomResourceOptions? opts = null)
    public ResourceDataSync(String name, ResourceDataSyncArgs args)
public ResourceDataSync(String name, ResourceDataSyncArgs args, CustomResourceOptions options)

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

    ResourceDataSync Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ResourceDataSync resource accepts the following input properties:

    BucketName string
    The name of the S3 bucket where the aggregated data is stored.
    BucketPrefix string
    An Amazon S3 prefix for the bucket.
    BucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    KmsKeyArn string
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    S3Destination Pulumi.AwsNative.Ssm.Inputs.ResourceDataSyncS3Destination
    Configuration information for the target S3 bucket.
    SyncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    SyncName string
    A name for the resource data sync.
    SyncSource Pulumi.AwsNative.Ssm.Inputs.ResourceDataSyncSyncSource
    Information about the source where the data was synchronized.
    SyncType string
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .
    BucketName string
    The name of the S3 bucket where the aggregated data is stored.
    BucketPrefix string
    An Amazon S3 prefix for the bucket.
    BucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    KmsKeyArn string
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    S3Destination ResourceDataSyncS3DestinationArgs
    Configuration information for the target S3 bucket.
    SyncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    SyncName string
    A name for the resource data sync.
    SyncSource ResourceDataSyncSyncSourceArgs
    Information about the source where the data was synchronized.
    SyncType string
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .
    bucketName String
    The name of the S3 bucket where the aggregated data is stored.
    bucketPrefix String
    An Amazon S3 prefix for the bucket.
    bucketRegion String
    The AWS Region with the S3 bucket targeted by the resource data sync.
    kmsKeyArn String
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    s3Destination ResourceDataSyncS3Destination
    Configuration information for the target S3 bucket.
    syncFormat String
    A supported sync format. The following format is currently supported: JsonSerDe
    syncName String
    A name for the resource data sync.
    syncSource ResourceDataSyncSyncSource
    Information about the source where the data was synchronized.
    syncType String
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .
    bucketName string
    The name of the S3 bucket where the aggregated data is stored.
    bucketPrefix string
    An Amazon S3 prefix for the bucket.
    bucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    kmsKeyArn string
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    s3Destination ResourceDataSyncS3Destination
    Configuration information for the target S3 bucket.
    syncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    syncName string
    A name for the resource data sync.
    syncSource ResourceDataSyncSyncSource
    Information about the source where the data was synchronized.
    syncType string
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .
    bucket_name str
    The name of the S3 bucket where the aggregated data is stored.
    bucket_prefix str
    An Amazon S3 prefix for the bucket.
    bucket_region str
    The AWS Region with the S3 bucket targeted by the resource data sync.
    kms_key_arn str
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    s3_destination ResourceDataSyncS3DestinationArgs
    Configuration information for the target S3 bucket.
    sync_format str
    A supported sync format. The following format is currently supported: JsonSerDe
    sync_name str
    A name for the resource data sync.
    sync_source ResourceDataSyncSyncSourceArgs
    Information about the source where the data was synchronized.
    sync_type str
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .
    bucketName String
    The name of the S3 bucket where the aggregated data is stored.
    bucketPrefix String
    An Amazon S3 prefix for the bucket.
    bucketRegion String
    The AWS Region with the S3 bucket targeted by the resource data sync.
    kmsKeyArn String
    The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.
    s3Destination Property Map
    Configuration information for the target S3 bucket.
    syncFormat String
    A supported sync format. The following format is currently supported: JsonSerDe
    syncName String
    A name for the resource data sync.
    syncSource Property Map
    Information about the source where the data was synchronized.
    syncType String
    The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

    Outputs

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

    ResourceDataSyncAwsOrganizationsSource, ResourceDataSyncAwsOrganizationsSourceArgs

    OrganizationSourceType string
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    OrganizationalUnits List<string>
    The AWS Organizations organization units included in the sync.
    OrganizationSourceType string
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    OrganizationalUnits []string
    The AWS Organizations organization units included in the sync.
    organizationSourceType String
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    organizationalUnits List<String>
    The AWS Organizations organization units included in the sync.
    organizationSourceType string
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    organizationalUnits string[]
    The AWS Organizations organization units included in the sync.
    organization_source_type str
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    organizational_units Sequence[str]
    The AWS Organizations organization units included in the sync.
    organizationSourceType String
    If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.
    organizationalUnits List<String>
    The AWS Organizations organization units included in the sync.

    ResourceDataSyncS3Destination, ResourceDataSyncS3DestinationArgs

    BucketName string
    The name of the S3 bucket where the aggregated data is stored.
    BucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    SyncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    BucketPrefix string
    An Amazon S3 prefix for the bucket.
    KmsKeyArn string
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
    BucketName string
    The name of the S3 bucket where the aggregated data is stored.
    BucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    SyncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    BucketPrefix string
    An Amazon S3 prefix for the bucket.
    KmsKeyArn string
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
    bucketName String
    The name of the S3 bucket where the aggregated data is stored.
    bucketRegion String
    The AWS Region with the S3 bucket targeted by the resource data sync.
    syncFormat String
    A supported sync format. The following format is currently supported: JsonSerDe
    bucketPrefix String
    An Amazon S3 prefix for the bucket.
    kmsKeyArn String
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
    bucketName string
    The name of the S3 bucket where the aggregated data is stored.
    bucketRegion string
    The AWS Region with the S3 bucket targeted by the resource data sync.
    syncFormat string
    A supported sync format. The following format is currently supported: JsonSerDe
    bucketPrefix string
    An Amazon S3 prefix for the bucket.
    kmsKeyArn string
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
    bucket_name str
    The name of the S3 bucket where the aggregated data is stored.
    bucket_region str
    The AWS Region with the S3 bucket targeted by the resource data sync.
    sync_format str
    A supported sync format. The following format is currently supported: JsonSerDe
    bucket_prefix str
    An Amazon S3 prefix for the bucket.
    kms_key_arn str
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
    bucketName String
    The name of the S3 bucket where the aggregated data is stored.
    bucketRegion String
    The AWS Region with the S3 bucket targeted by the resource data sync.
    syncFormat String
    A supported sync format. The following format is currently supported: JsonSerDe
    bucketPrefix String
    An Amazon S3 prefix for the bucket.
    kmsKeyArn String
    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.

    ResourceDataSyncSyncSource, ResourceDataSyncSyncSourceArgs

    SourceRegions List<string>
    The SyncSource AWS Regions included in the resource data sync.
    SourceType string
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    AwsOrganizationsSource Pulumi.AwsNative.Ssm.Inputs.ResourceDataSyncAwsOrganizationsSource
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    IncludeFutureRegions bool
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
    SourceRegions []string
    The SyncSource AWS Regions included in the resource data sync.
    SourceType string
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    AwsOrganizationsSource ResourceDataSyncAwsOrganizationsSource
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    IncludeFutureRegions bool
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
    sourceRegions List<String>
    The SyncSource AWS Regions included in the resource data sync.
    sourceType String
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    awsOrganizationsSource ResourceDataSyncAwsOrganizationsSource
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    includeFutureRegions Boolean
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
    sourceRegions string[]
    The SyncSource AWS Regions included in the resource data sync.
    sourceType string
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    awsOrganizationsSource ResourceDataSyncAwsOrganizationsSource
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    includeFutureRegions boolean
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
    source_regions Sequence[str]
    The SyncSource AWS Regions included in the resource data sync.
    source_type str
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    aws_organizations_source ResourceDataSyncAwsOrganizationsSource
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    include_future_regions bool
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
    sourceRegions List<String>
    The SyncSource AWS Regions included in the resource data sync.
    sourceType String
    The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .
    awsOrganizationsSource Property Map
    Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
    includeFutureRegions Boolean
    Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native