Documentation ¶
Index ¶
- func CfnCapability_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCapability_IsCfnElement(x interface{}) *bool
- func CfnCapability_IsCfnResource(x interface{}) *bool
- func CfnCapability_IsConstruct(x interface{}) *bool
- func CfnPartnership_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPartnership_IsCfnElement(x interface{}) *bool
- func CfnPartnership_IsCfnResource(x interface{}) *bool
- func CfnPartnership_IsConstruct(x interface{}) *bool
- func CfnProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProfile_IsCfnElement(x interface{}) *bool
- func CfnProfile_IsCfnResource(x interface{}) *bool
- func CfnProfile_IsConstruct(x interface{}) *bool
- func CfnTransformer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransformer_IsCfnElement(x interface{}) *bool
- func CfnTransformer_IsCfnResource(x interface{}) *bool
- func CfnTransformer_IsConstruct(x interface{}) *bool
- func NewCfnCapability_Override(c CfnCapability, scope constructs.Construct, id *string, ...)
- func NewCfnPartnership_Override(c CfnPartnership, scope constructs.Construct, id *string, ...)
- func NewCfnProfile_Override(c CfnProfile, scope constructs.Construct, id *string, props *CfnProfileProps)
- func NewCfnTransformer_Override(c CfnTransformer, scope constructs.Construct, id *string, ...)
- type CfnCapability
- type CfnCapabilityProps
- type CfnCapability_CapabilityConfigurationProperty
- type CfnCapability_EdiConfigurationProperty
- type CfnCapability_EdiTypeProperty
- type CfnCapability_S3LocationProperty
- type CfnCapability_X12DetailsProperty
- type CfnPartnership
- type CfnPartnershipProps
- type CfnPartnership_CapabilityOptionsProperty
- type CfnPartnership_OutboundEdiOptionsProperty
- type CfnPartnership_X12DelimitersProperty
- type CfnPartnership_X12EnvelopeProperty
- type CfnPartnership_X12FunctionalGroupHeadersProperty
- type CfnPartnership_X12InterchangeControlHeadersProperty
- type CfnPartnership_X12OutboundEdiHeadersProperty
- type CfnProfile
- type CfnProfileProps
- type CfnTransformer
- type CfnTransformerProps
- type CfnTransformer_EdiTypeProperty
- type CfnTransformer_FormatOptionsProperty
- type CfnTransformer_InputConversionProperty
- type CfnTransformer_MappingProperty
- type CfnTransformer_OutputConversionProperty
- type CfnTransformer_SampleDocumentKeysProperty
- type CfnTransformer_SampleDocumentsProperty
- type CfnTransformer_X12DetailsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCapability_CFN_RESOURCE_TYPE_NAME ¶
func CfnCapability_CFN_RESOURCE_TYPE_NAME() *string
func CfnCapability_IsCfnElement ¶
func CfnCapability_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 CfnCapability_IsCfnResource ¶
func CfnCapability_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCapability_IsConstruct ¶
func CfnCapability_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 CfnPartnership_CFN_RESOURCE_TYPE_NAME ¶
func CfnPartnership_CFN_RESOURCE_TYPE_NAME() *string
func CfnPartnership_IsCfnElement ¶
func CfnPartnership_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 CfnPartnership_IsCfnResource ¶
func CfnPartnership_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPartnership_IsConstruct ¶
func CfnPartnership_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 CfnProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnProfile_IsCfnElement ¶
func CfnProfile_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 CfnProfile_IsCfnResource ¶
func CfnProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProfile_IsConstruct ¶
func CfnProfile_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 CfnTransformer_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransformer_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransformer_IsCfnElement ¶
func CfnTransformer_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 CfnTransformer_IsCfnResource ¶
func CfnTransformer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransformer_IsConstruct ¶
func CfnTransformer_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 NewCfnCapability_Override ¶
func NewCfnCapability_Override(c CfnCapability, scope constructs.Construct, id *string, props *CfnCapabilityProps)
func NewCfnPartnership_Override ¶
func NewCfnPartnership_Override(c CfnPartnership, scope constructs.Construct, id *string, props *CfnPartnershipProps)
func NewCfnProfile_Override ¶
func NewCfnProfile_Override(c CfnProfile, scope constructs.Construct, id *string, props *CfnProfileProps)
func NewCfnTransformer_Override ¶
func NewCfnTransformer_Override(c CfnTransformer, scope constructs.Construct, id *string, props *CfnTransformerProps)
Types ¶
type CfnCapability ¶
type CfnCapability interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer. AttrCapabilityArn() *string // Returns a system-assigned unique identifier for the capability. AttrCapabilityId() *string // Returns a timestamp for creation date and time of the capability. AttrCreatedAt() *string // Returns a timestamp that identifies the most recent date and time that the capability was modified. AttrModifiedAt() *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 // Specifies a structure that contains the details for a capability. Configuration() interface{} SetConfiguration(val interface{}) // 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 // Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. InstructionsDocuments() interface{} SetInstructionsDocuments(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 display name of the capability. Name() *string SetName(val *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 // Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Returns the type of the capability. Type() *string SetType(val *string) // 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{}) }
Instantiates a capability based on the specified parameters.
A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
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" cfnCapability := awscdk.Aws_b2bi.NewCfnCapability(this, jsii.String("MyCfnCapability"), &CfnCapabilityProps{ Configuration: &CapabilityConfigurationProperty{ Edi: &EdiConfigurationProperty{ InputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, OutputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, TransformerId: jsii.String("transformerId"), Type: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, // the properties below are optional CapabilityDirection: jsii.String("capabilityDirection"), }, }, Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional InstructionsDocuments: []interface{}{ &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
func NewCfnCapability ¶
func NewCfnCapability(scope constructs.Construct, id *string, props *CfnCapabilityProps) CfnCapability
type CfnCapabilityProps ¶
type CfnCapabilityProps struct { // Specifies a structure that contains the details for a capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-configuration // Configuration interface{} `field:"required" json:"configuration" yaml:"configuration"` // The display name of the capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-name // Name *string `field:"required" json:"name" yaml:"name"` // Returns the type of the capability. // // Currently, only `edi` is supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-type // Type *string `field:"required" json:"type" yaml:"type"` // Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. // // Each item contains the name of the bucket and the key, to identify the document's location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-instructionsdocuments // InstructionsDocuments interface{} `field:"optional" json:"instructionsDocuments" yaml:"instructionsDocuments"` // Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. // // You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCapability`.
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" cfnCapabilityProps := &CfnCapabilityProps{ Configuration: &CapabilityConfigurationProperty{ Edi: &EdiConfigurationProperty{ InputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, OutputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, TransformerId: jsii.String("transformerId"), Type: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, // the properties below are optional CapabilityDirection: jsii.String("capabilityDirection"), }, }, Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional InstructionsDocuments: []interface{}{ &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html
type CfnCapability_CapabilityConfigurationProperty ¶
type CfnCapability_CapabilityConfigurationProperty struct { // An EDI (electronic data interchange) configuration object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html#cfn-b2bi-capability-capabilityconfiguration-edi // Edi interface{} `field:"required" json:"edi" yaml:"edi"` }
A capability object.
Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
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" capabilityConfigurationProperty := &CapabilityConfigurationProperty{ Edi: &EdiConfigurationProperty{ InputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, OutputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, TransformerId: jsii.String("transformerId"), Type: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, // the properties below are optional CapabilityDirection: jsii.String("capabilityDirection"), }, }
type CfnCapability_EdiConfigurationProperty ¶
type CfnCapability_EdiConfigurationProperty struct { // Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-inputlocation // InputLocation interface{} `field:"required" json:"inputLocation" yaml:"inputLocation"` // Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-outputlocation // OutputLocation interface{} `field:"required" json:"outputLocation" yaml:"outputLocation"` // Returns the system-assigned unique identifier for the transformer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-transformerid // TransformerId *string `field:"required" json:"transformerId" yaml:"transformerId"` // Returns the type of the capability. // // Currently, only `edi` is supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-type // Type interface{} `field:"required" json:"type" yaml:"type"` // Specifies whether this is capability is for inbound or outbound transformations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-capabilitydirection // CapabilityDirection *string `field:"optional" json:"capabilityDirection" yaml:"capabilityDirection"` }
Specifies the details for the EDI (electronic data interchange) transformation.
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" ediConfigurationProperty := &EdiConfigurationProperty{ InputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, OutputLocation: &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }, TransformerId: jsii.String("transformerId"), Type: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, // the properties below are optional CapabilityDirection: jsii.String("capabilityDirection"), }
type CfnCapability_EdiTypeProperty ¶
type CfnCapability_EdiTypeProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html#cfn-b2bi-capability-editype-x12details // X12Details interface{} `field:"required" json:"x12Details" yaml:"x12Details"` }
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" ediTypeProperty := &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }
type CfnCapability_S3LocationProperty ¶
type CfnCapability_S3LocationProperty struct { // Specifies the name of the Amazon S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-bucketname // BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"` // Specifies the Amazon S3 key for the file location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-key // Key *string `field:"optional" json:"key" yaml:"key"` }
Specifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange.
File locations in Amazon S3 are identified using a combination of the bucket and key.
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" s3LocationProperty := &S3LocationProperty{ BucketName: jsii.String("bucketName"), Key: jsii.String("key"), }
type CfnCapability_X12DetailsProperty ¶
type CfnCapability_X12DetailsProperty struct { // Returns an enumerated type where each value identifies an X12 transaction set. // // Transaction sets are maintained by the X12 Accredited Standards Committee. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-transactionset // TransactionSet *string `field:"optional" json:"transactionSet" yaml:"transactionSet"` // Returns the version to use for the specified X12 transaction set. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-version // Version *string `field:"optional" json:"version" yaml:"version"` }
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" x12DetailsProperty := &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }
type CfnPartnership ¶
type CfnPartnership interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Returns a timestamp for creation date and time of the partnership. AttrCreatedAt() *string // Returns a timestamp that identifies the most recent date and time that the partnership was modified. AttrModifiedAt() *string // Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer. AttrPartnershipArn() *string // Returns the unique, system-generated identifier for a partnership. AttrPartnershipId() *string // Returns the unique, system-generated identifier for a trading partner. AttrTradingPartnerId() *string // Returns one or more capabilities associated with this partnership. Capabilities() *[]*string SetCapabilities(val *[]*string) // Contains the details for an Outbound EDI capability. CapabilityOptions() interface{} SetCapabilityOptions(val interface{}) // 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 Email() *string SetEmail(val *string) // 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 // Returns the name of the partnership. Name() *string SetName(val *string) // The tree node. Node() constructs.Node Phone() *string SetPhone(val *string) // Returns the unique, system-generated identifier for the profile connected to this partnership. ProfileId() *string SetProfileId(val *string) // 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 // A key-value pair for a specific partnership. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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 partnership between a customer and a trading partner, based on the supplied parameters.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
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" cfnPartnership := awscdk.Aws_b2bi.NewCfnPartnership(this, jsii.String("MyCfnPartnership"), &CfnPartnershipProps{ Capabilities: []*string{ jsii.String("capabilities"), }, Email: jsii.String("email"), Name: jsii.String("name"), ProfileId: jsii.String("profileId"), // the properties below are optional CapabilityOptions: &CapabilityOptionsProperty{ OutboundEdi: &OutboundEdiOptionsProperty{ X12: &X12EnvelopeProperty{ Common: &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }, }, }, }, Phone: jsii.String("phone"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html
func NewCfnPartnership ¶
func NewCfnPartnership(scope constructs.Construct, id *string, props *CfnPartnershipProps) CfnPartnership
type CfnPartnershipProps ¶
type CfnPartnershipProps struct { // Returns one or more capabilities associated with this partnership. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilities // Capabilities *[]*string `field:"required" json:"capabilities" yaml:"capabilities"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-email // Email *string `field:"required" json:"email" yaml:"email"` // Returns the name of the partnership. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-name // Name *string `field:"required" json:"name" yaml:"name"` // Returns the unique, system-generated identifier for the profile connected to this partnership. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-profileid // ProfileId *string `field:"required" json:"profileId" yaml:"profileId"` // Contains the details for an Outbound EDI capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilityoptions // CapabilityOptions interface{} `field:"optional" json:"capabilityOptions" yaml:"capabilityOptions"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-phone // Phone *string `field:"optional" json:"phone" yaml:"phone"` // A key-value pair for a specific partnership. // // Tags are metadata that you can use to search for and group capabilities for various purposes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnPartnership`.
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" cfnPartnershipProps := &CfnPartnershipProps{ Capabilities: []*string{ jsii.String("capabilities"), }, Email: jsii.String("email"), Name: jsii.String("name"), ProfileId: jsii.String("profileId"), // the properties below are optional CapabilityOptions: &CapabilityOptionsProperty{ OutboundEdi: &OutboundEdiOptionsProperty{ X12: &X12EnvelopeProperty{ Common: &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }, }, }, }, Phone: jsii.String("phone"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html
type CfnPartnership_CapabilityOptionsProperty ¶ added in v2.161.0
type CfnPartnership_CapabilityOptionsProperty struct { // A structure that contains the outbound EDI options. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-outboundedi // OutboundEdi interface{} `field:"optional" json:"outboundEdi" yaml:"outboundEdi"` }
Contains the details for an Outbound EDI capability.
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" capabilityOptionsProperty := &CapabilityOptionsProperty{ OutboundEdi: &OutboundEdiOptionsProperty{ X12: &X12EnvelopeProperty{ Common: &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }, }, }, }
type CfnPartnership_OutboundEdiOptionsProperty ¶ added in v2.161.0
type CfnPartnership_OutboundEdiOptionsProperty struct { // A structure that contains an X12 envelope structure. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html#cfn-b2bi-partnership-outboundedioptions-x12 // X12 interface{} `field:"required" json:"x12" yaml:"x12"` }
A container for outbound EDI options.
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" outboundEdiOptionsProperty := &OutboundEdiOptionsProperty{ X12: &X12EnvelopeProperty{ Common: &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }, }, }
type CfnPartnership_X12DelimitersProperty ¶ added in v2.161.0
type CfnPartnership_X12DelimitersProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-componentseparator // ComponentSeparator *string `field:"optional" json:"componentSeparator" yaml:"componentSeparator"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-dataelementseparator // DataElementSeparator *string `field:"optional" json:"dataElementSeparator" yaml:"dataElementSeparator"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-segmentterminator // SegmentTerminator *string `field:"optional" json:"segmentTerminator" yaml:"segmentTerminator"` }
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" x12DelimitersProperty := &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }
type CfnPartnership_X12EnvelopeProperty ¶ added in v2.161.0
type CfnPartnership_X12EnvelopeProperty struct { // A container for the X12 outbound EDI headers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-common // Common interface{} `field:"optional" json:"common" yaml:"common"` }
A wrapper structure for an X12 definition object.
the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
- Interchange Envelope - Functional Group - Transaction Set.
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" x12EnvelopeProperty := &X12EnvelopeProperty{ Common: &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }, }
type CfnPartnership_X12FunctionalGroupHeadersProperty ¶ added in v2.161.0
type CfnPartnership_X12FunctionalGroupHeadersProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode // ApplicationReceiverCode *string `field:"optional" json:"applicationReceiverCode" yaml:"applicationReceiverCode"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode // ApplicationSenderCode *string `field:"optional" json:"applicationSenderCode" yaml:"applicationSenderCode"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode // ResponsibleAgencyCode *string `field:"optional" json:"responsibleAgencyCode" yaml:"responsibleAgencyCode"` }
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" x12FunctionalGroupHeadersProperty := &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }
type CfnPartnership_X12InterchangeControlHeadersProperty ¶ added in v2.161.0
type CfnPartnership_X12InterchangeControlHeadersProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode // AcknowledgmentRequestedCode *string `field:"optional" json:"acknowledgmentRequestedCode" yaml:"acknowledgmentRequestedCode"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid // ReceiverId *string `field:"optional" json:"receiverId" yaml:"receiverId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier // ReceiverIdQualifier *string `field:"optional" json:"receiverIdQualifier" yaml:"receiverIdQualifier"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator // RepetitionSeparator *string `field:"optional" json:"repetitionSeparator" yaml:"repetitionSeparator"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid // SenderId *string `field:"optional" json:"senderId" yaml:"senderId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier // SenderIdQualifier *string `field:"optional" json:"senderIdQualifier" yaml:"senderIdQualifier"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode // UsageIndicatorCode *string `field:"optional" json:"usageIndicatorCode" yaml:"usageIndicatorCode"` }
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" x12InterchangeControlHeadersProperty := &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }
type CfnPartnership_X12OutboundEdiHeadersProperty ¶ added in v2.161.0
type CfnPartnership_X12OutboundEdiHeadersProperty struct { // The delimiters, for example semicolon ( `;` ), that separates sections of the headers for the X12 object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-delimiters // Delimiters interface{} `field:"optional" json:"delimiters" yaml:"delimiters"` // The functional group headers for the X12 object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders // FunctionalGroupHeaders interface{} `field:"optional" json:"functionalGroupHeaders" yaml:"functionalGroupHeaders"` // In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders // InterchangeControlHeaders interface{} `field:"optional" json:"interchangeControlHeaders" yaml:"interchangeControlHeaders"` // Specifies whether or not to validate the EDI for this X12 object: `TRUE` or `FALSE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-validateedi // ValidateEdi interface{} `field:"optional" json:"validateEdi" yaml:"validateEdi"` }
A structure containing the details for an outbound EDI object.
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" x12OutboundEdiHeadersProperty := &X12OutboundEdiHeadersProperty{ Delimiters: &X12DelimitersProperty{ ComponentSeparator: jsii.String("componentSeparator"), DataElementSeparator: jsii.String("dataElementSeparator"), SegmentTerminator: jsii.String("segmentTerminator"), }, FunctionalGroupHeaders: &X12FunctionalGroupHeadersProperty{ ApplicationReceiverCode: jsii.String("applicationReceiverCode"), ApplicationSenderCode: jsii.String("applicationSenderCode"), ResponsibleAgencyCode: jsii.String("responsibleAgencyCode"), }, InterchangeControlHeaders: &X12InterchangeControlHeadersProperty{ AcknowledgmentRequestedCode: jsii.String("acknowledgmentRequestedCode"), ReceiverId: jsii.String("receiverId"), ReceiverIdQualifier: jsii.String("receiverIdQualifier"), RepetitionSeparator: jsii.String("repetitionSeparator"), SenderId: jsii.String("senderId"), SenderIdQualifier: jsii.String("senderIdQualifier"), UsageIndicatorCode: jsii.String("usageIndicatorCode"), }, ValidateEdi: jsii.Boolean(false), }
type CfnProfile ¶
type CfnProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Returns the timestamp for creation date and time of the profile. AttrCreatedAt() *string // Returns the name of the logging group. AttrLogGroupName() *string // Returns the timestamp that identifies the most recent date and time that the profile was modified. AttrModifiedAt() *string // Returns an Amazon Resource Name (ARN) for the profile. AttrProfileArn() *string AttrProfileId() *string // Returns the name for the business associated with this profile. BusinessName() *string SetBusinessName(val *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 Email() *string SetEmail(val *string) // Specifies whether or not logging is enabled for this profile. Logging() *string SetLogging(val *string) // 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 // Returns the display name for profile. Name() *string SetName(val *string) // The tree node. Node() constructs.Node Phone() *string SetPhone(val *string) // 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 // A key-value pair for a specific profile. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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 customer profile.
You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
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" cfnProfile := awscdk.Aws_b2bi.NewCfnProfile(this, jsii.String("MyCfnProfile"), &CfnProfileProps{ BusinessName: jsii.String("businessName"), Logging: jsii.String("logging"), Name: jsii.String("name"), Phone: jsii.String("phone"), // the properties below are optional Email: jsii.String("email"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html
func NewCfnProfile ¶
func NewCfnProfile(scope constructs.Construct, id *string, props *CfnProfileProps) CfnProfile
type CfnProfileProps ¶
type CfnProfileProps struct { // Returns the name for the business associated with this profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-businessname // BusinessName *string `field:"required" json:"businessName" yaml:"businessName"` // Specifies whether or not logging is enabled for this profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-logging // Logging *string `field:"required" json:"logging" yaml:"logging"` // Returns the display name for profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-name // Name *string `field:"required" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-phone // Phone *string `field:"required" json:"phone" yaml:"phone"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-email // Email *string `field:"optional" json:"email" yaml:"email"` // A key-value pair for a specific profile. // // Tags are metadata that you can use to search for and group capabilities for various purposes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnProfile`.
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" cfnProfileProps := &CfnProfileProps{ BusinessName: jsii.String("businessName"), Logging: jsii.String("logging"), Name: jsii.String("name"), Phone: jsii.String("phone"), // the properties below are optional Email: jsii.String("email"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html
type CfnTransformer ¶
type CfnTransformer interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // Returns a timestamp indicating when the transformer was created. // // For example, `2023-07-20T19:58:44.624Z` . AttrCreatedAt() *string // Returns a timestamp representing the date and time for the most recent change for the transformer object. AttrModifiedAt() *string // Returns an Amazon Resource Name (ARN) for a specific transformer. AttrTransformerArn() *string // The system-assigned unique identifier for the transformer. AttrTransformerId() *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 // Deprecated: this property has been deprecated. EdiType() interface{} // Deprecated: this property has been deprecated. SetEdiType(val interface{}) // Deprecated: this property has been deprecated. FileFormat() *string // Deprecated: this property has been deprecated. SetFileFormat(val *string) // Returns a structure that contains the format options for the transformation. InputConversion() interface{} SetInputConversion(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 // Returns the structure that contains the mapping template and its language (either XSLT or JSONATA). Mapping() interface{} SetMapping(val interface{}) // This shape is deprecated: This is a legacy trait. // Deprecated: this property has been deprecated. MappingTemplate() *string // Deprecated: this property has been deprecated. SetMappingTemplate(val *string) // Returns the descriptive name for the transformer. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Returns the `OutputConversion` object, which contains the format options for the outbound transformation. OutputConversion() interface{} SetOutputConversion(val interface{}) // 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 // This shape is deprecated: This is a legacy trait. // Deprecated: this property has been deprecated. SampleDocument() *string // Deprecated: this property has been deprecated. SetSampleDocument(val *string) // Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. SampleDocuments() interface{} SetSampleDocuments(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Returns the state of the newly created transformer. Status() *string SetStatus(val *string) // A key-value pair for a specific transformer. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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 transformer. AWS B2B Data Interchange currently supports two scenarios:.
- *Inbound EDI* : the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires. - *Outbound EDI* : the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
> The following fields are provided for backwards compatibility only: `fileFormat` , `mappingTemplate` , `ediType` , and `sampleDocument` . > > - Use the `mapping` data type in place of `mappingTemplate` and `fileFormat` > - Use the `sampleDocuments` data type in place of `sampleDocument` > - Use either the `inputConversion` or `outputConversion` in place of `ediType`.
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" cfnTransformer := awscdk.Aws_b2bi.NewCfnTransformer(this, jsii.String("MyCfnTransformer"), &CfnTransformerProps{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional EdiType: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, FileFormat: jsii.String("fileFormat"), InputConversion: &InputConversionProperty{ FromFormat: jsii.String("fromFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }, Mapping: &MappingProperty{ TemplateLanguage: jsii.String("templateLanguage"), // the properties below are optional Template: jsii.String("template"), }, MappingTemplate: jsii.String("mappingTemplate"), OutputConversion: &OutputConversionProperty{ ToFormat: jsii.String("toFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }, SampleDocument: jsii.String("sampleDocument"), SampleDocuments: &SampleDocumentsProperty{ BucketName: jsii.String("bucketName"), Keys: []interface{}{ &SampleDocumentKeysProperty{ Input: jsii.String("input"), Output: jsii.String("output"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html
func NewCfnTransformer ¶
func NewCfnTransformer(scope constructs.Construct, id *string, props *CfnTransformerProps) CfnTransformer
type CfnTransformerProps ¶
type CfnTransformerProps struct { // Returns the descriptive name for the transformer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-name // Name *string `field:"required" json:"name" yaml:"name"` // Returns the state of the newly created transformer. // // The transformer can be either `active` or `inactive` . For the transformer to be used in a capability, its status must `active` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-status // Status *string `field:"required" json:"status" yaml:"status"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-editype // // Deprecated: this property has been deprecated. EdiType interface{} `field:"optional" json:"ediType" yaml:"ediType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-fileformat // // Deprecated: this property has been deprecated. FileFormat *string `field:"optional" json:"fileFormat" yaml:"fileFormat"` // Returns a structure that contains the format options for the transformation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-inputconversion // InputConversion interface{} `field:"optional" json:"inputConversion" yaml:"inputConversion"` // Returns the structure that contains the mapping template and its language (either XSLT or JSONATA). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-mapping // Mapping interface{} `field:"optional" json:"mapping" yaml:"mapping"` // This shape is deprecated: This is a legacy trait. // // Please use input-conversion or output-conversion. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-mappingtemplate // // Deprecated: this property has been deprecated. MappingTemplate *string `field:"optional" json:"mappingTemplate" yaml:"mappingTemplate"` // Returns the `OutputConversion` object, which contains the format options for the outbound transformation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-outputconversion // OutputConversion interface{} `field:"optional" json:"outputConversion" yaml:"outputConversion"` // This shape is deprecated: This is a legacy trait. // // Please use input-conversion or output-conversion. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-sampledocument // // Deprecated: this property has been deprecated. SampleDocument *string `field:"optional" json:"sampleDocument" yaml:"sampleDocument"` // Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-sampledocuments // SampleDocuments interface{} `field:"optional" json:"sampleDocuments" yaml:"sampleDocuments"` // A key-value pair for a specific transformer. // // Tags are metadata that you can use to search for and group capabilities for various purposes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTransformer`.
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" cfnTransformerProps := &CfnTransformerProps{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional EdiType: &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, FileFormat: jsii.String("fileFormat"), InputConversion: &InputConversionProperty{ FromFormat: jsii.String("fromFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }, Mapping: &MappingProperty{ TemplateLanguage: jsii.String("templateLanguage"), // the properties below are optional Template: jsii.String("template"), }, MappingTemplate: jsii.String("mappingTemplate"), OutputConversion: &OutputConversionProperty{ ToFormat: jsii.String("toFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }, SampleDocument: jsii.String("sampleDocument"), SampleDocuments: &SampleDocumentsProperty{ BucketName: jsii.String("bucketName"), Keys: []interface{}{ &SampleDocumentKeysProperty{ Input: jsii.String("input"), Output: jsii.String("output"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html
type CfnTransformer_EdiTypeProperty ¶
type CfnTransformer_EdiTypeProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-editype.html#cfn-b2bi-transformer-editype-x12details // X12Details interface{} `field:"required" json:"x12Details" yaml:"x12Details"` }
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" ediTypeProperty := &EdiTypeProperty{ X12Details: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }
type CfnTransformer_FormatOptionsProperty ¶ added in v2.161.0
type CfnTransformer_FormatOptionsProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.html#cfn-b2bi-transformer-formatoptions-x12 // X12 interface{} `field:"required" json:"x12" yaml:"x12"` }
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" formatOptionsProperty := &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }
type CfnTransformer_InputConversionProperty ¶ added in v2.161.0
type CfnTransformer_InputConversionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-fromformat // FromFormat *string `field:"required" json:"fromFormat" yaml:"fromFormat"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-formatoptions // FormatOptions interface{} `field:"optional" json:"formatOptions" yaml:"formatOptions"` }
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" inputConversionProperty := &InputConversionProperty{ FromFormat: jsii.String("fromFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }
type CfnTransformer_MappingProperty ¶ added in v2.161.0
type CfnTransformer_MappingProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html#cfn-b2bi-transformer-mapping-templatelanguage // TemplateLanguage *string `field:"required" json:"templateLanguage" yaml:"templateLanguage"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html#cfn-b2bi-transformer-mapping-template // Template *string `field:"optional" json:"template" yaml:"template"` }
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" mappingProperty := &MappingProperty{ TemplateLanguage: jsii.String("templateLanguage"), // the properties below are optional Template: jsii.String("template"), }
type CfnTransformer_OutputConversionProperty ¶ added in v2.161.0
type CfnTransformer_OutputConversionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-toformat // ToFormat *string `field:"required" json:"toFormat" yaml:"toFormat"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-formatoptions // FormatOptions interface{} `field:"optional" json:"formatOptions" yaml:"formatOptions"` }
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" outputConversionProperty := &OutputConversionProperty{ ToFormat: jsii.String("toFormat"), // the properties below are optional FormatOptions: &FormatOptionsProperty{ X12: &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }, }, }
type CfnTransformer_SampleDocumentKeysProperty ¶ added in v2.161.0
type CfnTransformer_SampleDocumentKeysProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-output // Output *string `field:"optional" json:"output" yaml:"output"` }
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" sampleDocumentKeysProperty := &SampleDocumentKeysProperty{ Input: jsii.String("input"), Output: jsii.String("output"), }
type CfnTransformer_SampleDocumentsProperty ¶ added in v2.161.0
type CfnTransformer_SampleDocumentsProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html#cfn-b2bi-transformer-sampledocuments-bucketname // BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html#cfn-b2bi-transformer-sampledocuments-keys // Keys interface{} `field:"required" json:"keys" yaml:"keys"` }
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" sampleDocumentsProperty := &SampleDocumentsProperty{ BucketName: jsii.String("bucketName"), Keys: []interface{}{ &SampleDocumentKeysProperty{ Input: jsii.String("input"), Output: jsii.String("output"), }, }, }
type CfnTransformer_X12DetailsProperty ¶
type CfnTransformer_X12DetailsProperty struct { // Returns an enumerated type where each value identifies an X12 transaction set. // // Transaction sets are maintained by the X12 Accredited Standards Committee. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-transactionset // TransactionSet *string `field:"optional" json:"transactionSet" yaml:"transactionSet"` // Returns the version to use for the specified X12 transaction set. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-version // Version *string `field:"optional" json:"version" yaml:"version"` }
A structure that contains the X12 transaction set and version.
The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
> If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the 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" x12DetailsProperty := &X12DetailsProperty{ TransactionSet: jsii.String("transactionSet"), Version: jsii.String("version"), }
Source Files ¶
- CfnCapability.go
- CfnCapabilityProps.go
- CfnCapability_CapabilityConfigurationProperty.go
- CfnCapability_EdiConfigurationProperty.go
- CfnCapability_EdiTypeProperty.go
- CfnCapability_S3LocationProperty.go
- CfnCapability_X12DetailsProperty.go
- CfnCapability__checks.go
- CfnPartnership.go
- CfnPartnershipProps.go
- CfnPartnership_CapabilityOptionsProperty.go
- CfnPartnership_OutboundEdiOptionsProperty.go
- CfnPartnership_X12DelimitersProperty.go
- CfnPartnership_X12EnvelopeProperty.go
- CfnPartnership_X12FunctionalGroupHeadersProperty.go
- CfnPartnership_X12InterchangeControlHeadersProperty.go
- CfnPartnership_X12OutboundEdiHeadersProperty.go
- CfnPartnership__checks.go
- CfnProfile.go
- CfnProfileProps.go
- CfnProfile__checks.go
- CfnTransformer.go
- CfnTransformerProps.go
- CfnTransformer_EdiTypeProperty.go
- CfnTransformer_FormatOptionsProperty.go
- CfnTransformer_InputConversionProperty.go
- CfnTransformer_MappingProperty.go
- CfnTransformer_OutputConversionProperty.go
- CfnTransformer_SampleDocumentKeysProperty.go
- CfnTransformer_SampleDocumentsProperty.go
- CfnTransformer_X12DetailsProperty.go
- CfnTransformer__checks.go
- main.go