awsconnectcampaigns

package
v1.204.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Jun 19, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::ConnectCampaigns Construct Library

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

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

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnCampaign_CFN_RESOURCE_TYPE_NAME 

func CfnCampaign_CFN_RESOURCE_TYPE_NAME() *string

func CfnCampaign_IsCfnElement 

func CfnCampaign_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. Experimental.

func CfnCampaign_IsCfnResource 

func CfnCampaign_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnCampaign_IsConstruct 

func CfnCampaign_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnCampaign_Override 

func NewCfnCampaign_Override(c CfnCampaign, scope awscdk.Construct, id *string, props *CfnCampaignProps)

Create a new `AWS::ConnectCampaigns::Campaign`.

Types

type CfnCampaign 

type CfnCampaign interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the high-volume outbound campaign.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// The Amazon Resource Name (ARN) of the Amazon Connect instance.
	ConnectInstanceArn() *string
	SetConnectInstanceArn(val *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.
	// Experimental.
	CreationStack() *[]*string
	// Contains information about the dialer configuration.
	DialerConfig() interface{}
	SetDialerConfig(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.
	// Experimental.
	LogicalId() *string
	// The name of the campaign.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Contains information about the outbound call configuration.
	OutboundCallConfig() interface{}
	SetOutboundCallConfig(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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The tags used to organize, track, or control access for this resource.
	//
	// For example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	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.
	// Experimental.
	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.
	//
	// Experimental.
	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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	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`).
	// Experimental.
	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.
	// Experimental.
	GetAtt(attributeName *string) 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ConnectCampaigns::Campaign`.

Contains information about an outbound campaign.

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"

cfnCampaign := awscdk.Aws_connectcampaigns.NewCfnCampaign(this, jsii.String("MyCfnCampaign"), &CfnCampaignProps{
	ConnectInstanceArn: jsii.String("connectInstanceArn"),
	DialerConfig: &DialerConfigProperty{
		PredictiveDialerConfig: &PredictiveDialerConfigProperty{
			BandwidthAllocation: jsii.Number(123),
		},
		ProgressiveDialerConfig: &ProgressiveDialerConfigProperty{
			BandwidthAllocation: jsii.Number(123),
		},
	},
	Name: jsii.String("name"),
	OutboundCallConfig: &OutboundCallConfigProperty{
		ConnectContactFlowArn: jsii.String("connectContactFlowArn"),
		ConnectQueueArn: jsii.String("connectQueueArn"),

		// the properties below are optional
		AnswerMachineDetectionConfig: &AnswerMachineDetectionConfigProperty{
			EnableAnswerMachineDetection: jsii.Boolean(false),
		},
		ConnectSourcePhoneNumber: jsii.String("connectSourcePhoneNumber"),
	},

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

func NewCfnCampaign 

func NewCfnCampaign(scope awscdk.Construct, id *string, props *CfnCampaignProps) CfnCampaign

Create a new `AWS::ConnectCampaigns::Campaign`.

type CfnCampaignProps 

type CfnCampaignProps struct {
	// The Amazon Resource Name (ARN) of the Amazon Connect instance.
	ConnectInstanceArn *string `field:"required" json:"connectInstanceArn" yaml:"connectInstanceArn"`
	// Contains information about the dialer configuration.
	DialerConfig interface{} `field:"required" json:"dialerConfig" yaml:"dialerConfig"`
	// The name of the campaign.
	Name *string `field:"required" json:"name" yaml:"name"`
	// Contains information about the outbound call configuration.
	OutboundCallConfig interface{} `field:"required" json:"outboundCallConfig" yaml:"outboundCallConfig"`
	// The tags used to organize, track, or control access for this resource.
	//
	// For example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnCampaign`.

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"

cfnCampaignProps := &CfnCampaignProps{
	ConnectInstanceArn: jsii.String("connectInstanceArn"),
	DialerConfig: &DialerConfigProperty{
		PredictiveDialerConfig: &PredictiveDialerConfigProperty{
			BandwidthAllocation: jsii.Number(123),
		},
		ProgressiveDialerConfig: &ProgressiveDialerConfigProperty{
			BandwidthAllocation: jsii.Number(123),
		},
	},
	Name: jsii.String("name"),
	OutboundCallConfig: &OutboundCallConfigProperty{
		ConnectContactFlowArn: jsii.String("connectContactFlowArn"),
		ConnectQueueArn: jsii.String("connectQueueArn"),

		// the properties below are optional
		AnswerMachineDetectionConfig: &AnswerMachineDetectionConfigProperty{
			EnableAnswerMachineDetection: jsii.Boolean(false),
		},
		ConnectSourcePhoneNumber: jsii.String("connectSourcePhoneNumber"),
	},

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

type CfnCampaign_AnswerMachineDetectionConfigProperty 

type CfnCampaign_AnswerMachineDetectionConfigProperty struct {
	// `CfnCampaign.AnswerMachineDetectionConfigProperty.EnableAnswerMachineDetection`.
	EnableAnswerMachineDetection interface{} `field:"required" json:"enableAnswerMachineDetection" yaml:"enableAnswerMachineDetection"`
}

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"

answerMachineDetectionConfigProperty := &AnswerMachineDetectionConfigProperty{
	EnableAnswerMachineDetection: jsii.Boolean(false),
}

type CfnCampaign_DialerConfigProperty 

type CfnCampaign_DialerConfigProperty struct {
	// The configuration of the predictive dialer.
	PredictiveDialerConfig interface{} `field:"optional" json:"predictiveDialerConfig" yaml:"predictiveDialerConfig"`
	// The configuration of the progressive dialer.
	ProgressiveDialerConfig interface{} `field:"optional" json:"progressiveDialerConfig" yaml:"progressiveDialerConfig"`
}

Contains dialer configuration for an outbound campaign.

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"

dialerConfigProperty := &DialerConfigProperty{
	PredictiveDialerConfig: &PredictiveDialerConfigProperty{
		BandwidthAllocation: jsii.Number(123),
	},
	ProgressiveDialerConfig: &ProgressiveDialerConfigProperty{
		BandwidthAllocation: jsii.Number(123),
	},
}

type CfnCampaign_OutboundCallConfigProperty 

type CfnCampaign_OutboundCallConfigProperty struct {
	// The Amazon Resource Name (ARN) of the flow.
	ConnectContactFlowArn *string `field:"required" json:"connectContactFlowArn" yaml:"connectContactFlowArn"`
	// The Amazon Resource Name (ARN) of the queue.
	ConnectQueueArn *string `field:"required" json:"connectQueueArn" yaml:"connectQueueArn"`
	// `CfnCampaign.OutboundCallConfigProperty.AnswerMachineDetectionConfig`.
	AnswerMachineDetectionConfig interface{} `field:"optional" json:"answerMachineDetectionConfig" yaml:"answerMachineDetectionConfig"`
	// The phone number associated with the outbound call.
	//
	// This is the caller ID that is displayed to customers when an agent calls them.
	ConnectSourcePhoneNumber *string `field:"optional" json:"connectSourcePhoneNumber" yaml:"connectSourcePhoneNumber"`
}

Contains outbound call configuration for an outbound campaign.

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"

outboundCallConfigProperty := &OutboundCallConfigProperty{
	ConnectContactFlowArn: jsii.String("connectContactFlowArn"),
	ConnectQueueArn: jsii.String("connectQueueArn"),

	// the properties below are optional
	AnswerMachineDetectionConfig: &AnswerMachineDetectionConfigProperty{
		EnableAnswerMachineDetection: jsii.Boolean(false),
	},
	ConnectSourcePhoneNumber: jsii.String("connectSourcePhoneNumber"),
}

type CfnCampaign_PredictiveDialerConfigProperty 

type CfnCampaign_PredictiveDialerConfigProperty struct {
	// Bandwidth allocation for the predictive dialer.
	BandwidthAllocation *float64 `field:"required" json:"bandwidthAllocation" yaml:"bandwidthAllocation"`
}

Contains predictive dialer configuration for an outbound campaign.

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"

predictiveDialerConfigProperty := &PredictiveDialerConfigProperty{
	BandwidthAllocation: jsii.Number(123),
}

type CfnCampaign_ProgressiveDialerConfigProperty 

type CfnCampaign_ProgressiveDialerConfigProperty struct {
	// Bandwidth allocation for the progressive dialer.
	BandwidthAllocation *float64 `field:"required" json:"bandwidthAllocation" yaml:"bandwidthAllocation"`
}

Contains progressive dialer configuration for an outbound campaign.

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"

progressiveDialerConfigProperty := &ProgressiveDialerConfigProperty{
	BandwidthAllocation: jsii.Number(123),
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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