awsbcmdataexports

package
v2.142.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::BCMDataExports Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

This module is part of the AWS Cloud Development Kit project.

import bcmdataexports "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::BCMDataExports.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnExport_CFN_RESOURCE_TYPE_NAME 

func CfnExport_CFN_RESOURCE_TYPE_NAME() *string

func CfnExport_IsCfnElement 

func CfnExport_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnExport_IsCfnResource 

func CfnExport_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnExport_IsConstruct 

func CfnExport_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnExport_Override 

func NewCfnExport_Override(c CfnExport, scope constructs.Construct, id *string, props *CfnExportProps)

Types

type CfnExport 

type CfnExport interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggableV2
	// The Amazon Resource Name (ARN) for this export.
	AttrExportArn() *string
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The details that are available for an export.
	Export() interface{}
	SetExport(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	Tags() *[]*CfnExport_ResourceTagProperty
	SetTags(val *[]*CfnExport_ResourceTagProperty)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A `DataQuery` consists of both a `QueryStatement` and `TableConfigurations` .

The `QueryStatement` is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see [Data query](https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html) . To view the available tables and columns, see the [Data Exports table dictionary](https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html) .

The `TableConfigurations` is a collection of specified `TableProperties` for the table being queried in the `QueryStatement` . TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see [Data query](https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html) . To view the table properties available for each table, see the [Data Exports table dictionary](https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html) or use the `ListTables` API to get a response of all tables and their available properties.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnExport := awscdk.Aws_bcmdataexports.NewCfnExport(this, jsii.String("MyCfnExport"), &CfnExportProps{
	Export: &ExportProperty{
		DataQuery: &DataQueryProperty{
			QueryStatement: jsii.String("queryStatement"),

			// the properties below are optional
			TableConfigurations: map[string]interface{}{
				"tableConfigurationsKey": map[string]*string{
					"tableConfigurationsKey": jsii.String("tableConfigurations"),
				},
			},
		},
		DestinationConfigurations: &DestinationConfigurationsProperty{
			S3Destination: &S3DestinationProperty{
				S3Bucket: jsii.String("s3Bucket"),
				S3OutputConfigurations: &S3OutputConfigurationsProperty{
					Compression: jsii.String("compression"),
					Format: jsii.String("format"),
					OutputType: jsii.String("outputType"),
					Overwrite: jsii.String("overwrite"),
				},
				S3Prefix: jsii.String("s3Prefix"),
				S3Region: jsii.String("s3Region"),
			},
		},
		Name: jsii.String("name"),
		RefreshCadence: &RefreshCadenceProperty{
			Frequency: jsii.String("frequency"),
		},

		// the properties below are optional
		Description: jsii.String("description"),
		ExportArn: jsii.String("exportArn"),
	},

	// the properties below are optional
	Tags: []resourceTagProperty{
		&resourceTagProperty{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcmdataexports-export.html

func NewCfnExport 

func NewCfnExport(scope constructs.Construct, id *string, props *CfnExportProps) CfnExport

type CfnExportProps 

type CfnExportProps struct {
	// The details that are available for an export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcmdataexports-export.html#cfn-bcmdataexports-export-export
	//
	Export interface{} `field:"required" json:"export" yaml:"export"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcmdataexports-export.html#cfn-bcmdataexports-export-tags
	//
	Tags *[]*CfnExport_ResourceTagProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnExport`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnExportProps := &CfnExportProps{
	Export: &ExportProperty{
		DataQuery: &DataQueryProperty{
			QueryStatement: jsii.String("queryStatement"),

			// the properties below are optional
			TableConfigurations: map[string]interface{}{
				"tableConfigurationsKey": map[string]*string{
					"tableConfigurationsKey": jsii.String("tableConfigurations"),
				},
			},
		},
		DestinationConfigurations: &DestinationConfigurationsProperty{
			S3Destination: &S3DestinationProperty{
				S3Bucket: jsii.String("s3Bucket"),
				S3OutputConfigurations: &S3OutputConfigurationsProperty{
					Compression: jsii.String("compression"),
					Format: jsii.String("format"),
					OutputType: jsii.String("outputType"),
					Overwrite: jsii.String("overwrite"),
				},
				S3Prefix: jsii.String("s3Prefix"),
				S3Region: jsii.String("s3Region"),
			},
		},
		Name: jsii.String("name"),
		RefreshCadence: &RefreshCadenceProperty{
			Frequency: jsii.String("frequency"),
		},

		// the properties below are optional
		Description: jsii.String("description"),
		ExportArn: jsii.String("exportArn"),
	},

	// the properties below are optional
	Tags: []resourceTagProperty{
		&resourceTagProperty{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcmdataexports-export.html

type CfnExport_DataQueryProperty 

type CfnExport_DataQueryProperty struct {
	// The query statement.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html#cfn-bcmdataexports-export-dataquery-querystatement
	//
	QueryStatement *string `field:"required" json:"queryStatement" yaml:"queryStatement"`
	// The table configuration.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html#cfn-bcmdataexports-export-dataquery-tableconfigurations
	//
	TableConfigurations interface{} `field:"optional" json:"tableConfigurations" yaml:"tableConfigurations"`
}

The SQL query of column selections and row filters from the data table you want.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dataQueryProperty := &DataQueryProperty{
	QueryStatement: jsii.String("queryStatement"),

	// the properties below are optional
	TableConfigurations: map[string]interface{}{
		"tableConfigurationsKey": map[string]*string{
			"tableConfigurationsKey": jsii.String("tableConfigurations"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html

type CfnExport_DestinationConfigurationsProperty 

type CfnExport_DestinationConfigurationsProperty struct {
	// An object that describes the destination of the data exports file.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-destinationconfigurations.html#cfn-bcmdataexports-export-destinationconfigurations-s3destination
	//
	S3Destination interface{} `field:"required" json:"s3Destination" yaml:"s3Destination"`
}

The destinations used for data exports.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

destinationConfigurationsProperty := &DestinationConfigurationsProperty{
	S3Destination: &S3DestinationProperty{
		S3Bucket: jsii.String("s3Bucket"),
		S3OutputConfigurations: &S3OutputConfigurationsProperty{
			Compression: jsii.String("compression"),
			Format: jsii.String("format"),
			OutputType: jsii.String("outputType"),
			Overwrite: jsii.String("overwrite"),
		},
		S3Prefix: jsii.String("s3Prefix"),
		S3Region: jsii.String("s3Region"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-destinationconfigurations.html

type CfnExport_ExportProperty 

type CfnExport_ExportProperty struct {
	// The data query for this specific data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-dataquery
	//
	DataQuery interface{} `field:"required" json:"dataQuery" yaml:"dataQuery"`
	// The destination configuration for this specific data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-destinationconfigurations
	//
	DestinationConfigurations interface{} `field:"required" json:"destinationConfigurations" yaml:"destinationConfigurations"`
	// The name of this specific data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-name
	//
	Name *string `field:"required" json:"name" yaml:"name"`
	// The cadence for AWS to update the export in your S3 bucket.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-refreshcadence
	//
	RefreshCadence interface{} `field:"required" json:"refreshCadence" yaml:"refreshCadence"`
	// The description for this specific data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-description
	//
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) for this export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-exportarn
	//
	ExportArn *string `field:"optional" json:"exportArn" yaml:"exportArn"`
}

The details that are available for an export.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

exportProperty := &ExportProperty{
	DataQuery: &DataQueryProperty{
		QueryStatement: jsii.String("queryStatement"),

		// the properties below are optional
		TableConfigurations: map[string]interface{}{
			"tableConfigurationsKey": map[string]*string{
				"tableConfigurationsKey": jsii.String("tableConfigurations"),
			},
		},
	},
	DestinationConfigurations: &DestinationConfigurationsProperty{
		S3Destination: &S3DestinationProperty{
			S3Bucket: jsii.String("s3Bucket"),
			S3OutputConfigurations: &S3OutputConfigurationsProperty{
				Compression: jsii.String("compression"),
				Format: jsii.String("format"),
				OutputType: jsii.String("outputType"),
				Overwrite: jsii.String("overwrite"),
			},
			S3Prefix: jsii.String("s3Prefix"),
			S3Region: jsii.String("s3Region"),
		},
	},
	Name: jsii.String("name"),
	RefreshCadence: &RefreshCadenceProperty{
		Frequency: jsii.String("frequency"),
	},

	// the properties below are optional
	Description: jsii.String("description"),
	ExportArn: jsii.String("exportArn"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html

type CfnExport_RefreshCadenceProperty 

type CfnExport_RefreshCadenceProperty struct {
	// The frequency that data exports are updated.
	//
	// The export refreshes each time the source data updates, up to three times daily.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-refreshcadence.html#cfn-bcmdataexports-export-refreshcadence-frequency
	//
	Frequency *string `field:"required" json:"frequency" yaml:"frequency"`
}

The cadence for AWS to update the data export in your S3 bucket.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

refreshCadenceProperty := &RefreshCadenceProperty{
	Frequency: jsii.String("frequency"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-refreshcadence.html

type CfnExport_ResourceTagProperty 

type CfnExport_ResourceTagProperty struct {
	// The key that's associated with the tag.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html#cfn-bcmdataexports-export-resourcetag-key
	//
	Key *string `field:"required" json:"key" yaml:"key"`
	// The value that's associated with the tag.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html#cfn-bcmdataexports-export-resourcetag-value
	//
	Value *string `field:"required" json:"value" yaml:"value"`
}

The tag structure that contains a tag key and value.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

resourceTagProperty := &ResourceTagProperty{
	Key: jsii.String("key"),
	Value: jsii.String("value"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html

type CfnExport_S3DestinationProperty 

type CfnExport_S3DestinationProperty struct {
	// The name of the Amazon S3 bucket used as the destination of a data export file.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3bucket
	//
	S3Bucket *string `field:"required" json:"s3Bucket" yaml:"s3Bucket"`
	// The output configuration for the data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3outputconfigurations
	//
	S3OutputConfigurations interface{} `field:"required" json:"s3OutputConfigurations" yaml:"s3OutputConfigurations"`
	// The S3 path prefix you want prepended to the name of your data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3prefix
	//
	S3Prefix *string `field:"required" json:"s3Prefix" yaml:"s3Prefix"`
	// The S3 bucket Region.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3region
	//
	S3Region *string `field:"required" json:"s3Region" yaml:"s3Region"`
}

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a data exports file.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3DestinationProperty := &S3DestinationProperty{
	S3Bucket: jsii.String("s3Bucket"),
	S3OutputConfigurations: &S3OutputConfigurationsProperty{
		Compression: jsii.String("compression"),
		Format: jsii.String("format"),
		OutputType: jsii.String("outputType"),
		Overwrite: jsii.String("overwrite"),
	},
	S3Prefix: jsii.String("s3Prefix"),
	S3Region: jsii.String("s3Region"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html

type CfnExport_S3OutputConfigurationsProperty 

type CfnExport_S3OutputConfigurationsProperty struct {
	// The compression type for the data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-compression
	//
	Compression *string `field:"required" json:"compression" yaml:"compression"`
	// The file format for the data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-format
	//
	Format *string `field:"required" json:"format" yaml:"format"`
	// The output type for the data export.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-outputtype
	//
	OutputType *string `field:"required" json:"outputType" yaml:"outputType"`
	// The rule to follow when generating a version of the data export file.
	//
	// You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-overwrite
	//
	Overwrite *string `field:"required" json:"overwrite" yaml:"overwrite"`
}

The compression type, file format, and overwrite preference for the data export.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3OutputConfigurationsProperty := &S3OutputConfigurationsProperty{
	Compression: jsii.String("compression"),
	Format: jsii.String("format"),
	OutputType: jsii.String("outputType"),
	Overwrite: jsii.String("overwrite"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.