awsscheduler

package
v2.63.1 Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2023 License: Apache-2.0 Imports: 7 Imported by: 1

README

AWS::Scheduler Construct Library

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

import scheduler "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::Scheduler.

(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 CfnScheduleGroup_CFN_RESOURCE_TYPE_NAME 

func CfnScheduleGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnScheduleGroup_IsCfnElement 

func CfnScheduleGroup_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 CfnScheduleGroup_IsCfnResource 

func CfnScheduleGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnScheduleGroup_IsConstruct 

func CfnScheduleGroup_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 CfnSchedule_CFN_RESOURCE_TYPE_NAME 

func CfnSchedule_CFN_RESOURCE_TYPE_NAME() *string

func CfnSchedule_IsCfnElement 

func CfnSchedule_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 CfnSchedule_IsCfnResource 

func CfnSchedule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSchedule_IsConstruct 

func CfnSchedule_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 NewCfnScheduleGroup_Override 

func NewCfnScheduleGroup_Override(c CfnScheduleGroup, scope constructs.Construct, id *string, props *CfnScheduleGroupProps)

Create a new `AWS::Scheduler::ScheduleGroup`.

func NewCfnSchedule_Override 

func NewCfnSchedule_Override(c CfnSchedule, scope constructs.Construct, id *string, props *CfnScheduleProps)

Create a new `AWS::Scheduler::Schedule`.

Types

type CfnSchedule 

type CfnSchedule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The description you specify for the schedule.
	Description() *string
	SetDescription(val *string)
	// The date, in UTC, before which the schedule can invoke its target.
	//
	// Depending on the schedule's recurrence expression, invocations might stop on, or before, the `EndDate` you specify.
	// EventBridge Scheduler ignores `EndDate` for one-time schedules.
	EndDate() *string
	SetEndDate(val *string)
	// Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
	FlexibleTimeWindow() interface{}
	SetFlexibleTimeWindow(val interface{})
	// The name of the schedule group associated with this schedule.
	GroupName() *string
	SetGroupName(val *string)
	// The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
	KmsKeyArn() *string
	SetKmsKeyArn(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
	// The name of the schedule.
	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 expression that defines when the schedule runs. The following formats are supported.
	//
	// - `at` expression - `at(yyyy-mm-ddThh:mm:ss)`
	// - `rate` expression - `rate(unit value)`
	// - `cron` expression - `cron(fields)`
	//
	// You can use `at` expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use `rate` and `cron` expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
	//
	// A `cron` expression consists of six fields separated by white spaces: `(minutes hours day_of_month month day_of_week year)` .
	//
	// A `rate` expression consists of a *value* as a positive integer, and a *unit* with the following options: `minute` | `minutes` | `hour` | `hours` | `day` | `days`
	//
	// For more information and examples, see [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .
	ScheduleExpression() *string
	SetScheduleExpression(val *string)
	// The timezone in which the scheduling expression is evaluated.
	ScheduleExpressionTimezone() *string
	SetScheduleExpressionTimezone(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The date, in UTC, after which the schedule can begin invoking its target.
	//
	// Depending on the schedule's recurrence expression, invocations might occur on, or after, the `StartDate` you specify.
	// EventBridge Scheduler ignores `StartDate` for one-time schedules.
	StartDate() *string
	SetStartDate(val *string)
	// Specifies whether the schedule is enabled or disabled.
	State() *string
	SetState(val *string)
	// The schedule's target details.
	Target() interface{}
	SetTarget(val interface{})
	// 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{})
}

A CloudFormation `AWS::Scheduler::Schedule`.

Creates the specified schedule.

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"

var tags interface{}

cfnSchedule := awscdk.Aws_scheduler.NewCfnSchedule(this, jsii.String("MyCfnSchedule"), &cfnScheduleProps{
	flexibleTimeWindow: &flexibleTimeWindowProperty{
		mode: jsii.String("mode"),

		// the properties below are optional
		maximumWindowInMinutes: jsii.Number(123),
	},
	scheduleExpression: jsii.String("scheduleExpression"),
	target: &targetProperty{
		arn: jsii.String("arn"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		deadLetterConfig: &deadLetterConfigProperty{
			arn: jsii.String("arn"),
		},
		ecsParameters: &ecsParametersProperty{
			taskDefinitionArn: jsii.String("taskDefinitionArn"),

			// the properties below are optional
			capacityProviderStrategy: []interface{}{
				&capacityProviderStrategyItemProperty{
					capacityProvider: jsii.String("capacityProvider"),

					// the properties below are optional
					base: jsii.Number(123),
					weight: jsii.Number(123),
				},
			},
			enableEcsManagedTags: jsii.Boolean(false),
			enableExecuteCommand: jsii.Boolean(false),
			group: jsii.String("group"),
			launchType: jsii.String("launchType"),
			networkConfiguration: &networkConfigurationProperty{
				awsvpcConfiguration: &awsVpcConfigurationProperty{
					subnets: []*string{
						jsii.String("subnets"),
					},

					// the properties below are optional
					assignPublicIp: jsii.String("assignPublicIp"),
					securityGroups: []*string{
						jsii.String("securityGroups"),
					},
				},
			},
			placementConstraints: []interface{}{
				&placementConstraintProperty{
					expression: jsii.String("expression"),
					type: jsii.String("type"),
				},
			},
			placementStrategy: []interface{}{
				&placementStrategyProperty{
					field: jsii.String("field"),
					type: jsii.String("type"),
				},
			},
			platformVersion: jsii.String("platformVersion"),
			propagateTags: jsii.String("propagateTags"),
			referenceId: jsii.String("referenceId"),
			tags: tags,
			taskCount: jsii.Number(123),
		},
		eventBridgeParameters: &eventBridgeParametersProperty{
			detailType: jsii.String("detailType"),
			source: jsii.String("source"),
		},
		input: jsii.String("input"),
		kinesisParameters: &kinesisParametersProperty{
			partitionKey: jsii.String("partitionKey"),
		},
		retryPolicy: &retryPolicyProperty{
			maximumEventAgeInSeconds: jsii.Number(123),
			maximumRetryAttempts: jsii.Number(123),
		},
		sageMakerPipelineParameters: &sageMakerPipelineParametersProperty{
			pipelineParameterList: []interface{}{
				&sageMakerPipelineParameterProperty{
					name: jsii.String("name"),
					value: jsii.String("value"),
				},
			},
		},
		sqsParameters: &sqsParametersProperty{
			messageGroupId: jsii.String("messageGroupId"),
		},
	},

	// the properties below are optional
	description: jsii.String("description"),
	endDate: jsii.String("endDate"),
	groupName: jsii.String("groupName"),
	kmsKeyArn: jsii.String("kmsKeyArn"),
	name: jsii.String("name"),
	scheduleExpressionTimezone: jsii.String("scheduleExpressionTimezone"),
	startDate: jsii.String("startDate"),
	state: jsii.String("state"),
})

func NewCfnSchedule 

func NewCfnSchedule(scope constructs.Construct, id *string, props *CfnScheduleProps) CfnSchedule

Create a new `AWS::Scheduler::Schedule`.

type CfnScheduleGroup 

type CfnScheduleGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the schedule group.
	AttrArn() *string
	// The date and time at which the schedule group was created.
	AttrCreationDate() *string
	// The time at which the schedule group was last modified.
	AttrLastModificationDate() *string
	// Specifies the state of the schedule group.
	//
	// Valid values are `ACTIVE` and `DELETING` .
	AttrState() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The 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 name of the schedule group.
	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
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags() awscdk.TagManager
	// 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{})
}

A CloudFormation `AWS::Scheduler::ScheduleGroup`.

Creates the specified schedule group.

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"

cfnScheduleGroup := awscdk.Aws_scheduler.NewCfnScheduleGroup(this, jsii.String("MyCfnScheduleGroup"), &cfnScheduleGroupProps{
	name: jsii.String("name"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnScheduleGroup 

func NewCfnScheduleGroup(scope constructs.Construct, id *string, props *CfnScheduleGroupProps) CfnScheduleGroup

Create a new `AWS::Scheduler::ScheduleGroup`.

type CfnScheduleGroupProps 

type CfnScheduleGroupProps struct {
	// The name of the schedule group.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnScheduleGroup`.

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"

cfnScheduleGroupProps := &cfnScheduleGroupProps{
	name: jsii.String("name"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnScheduleProps 

type CfnScheduleProps struct {
	// Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
	FlexibleTimeWindow interface{} `field:"required" json:"flexibleTimeWindow" yaml:"flexibleTimeWindow"`
	// The expression that defines when the schedule runs. The following formats are supported.
	//
	// - `at` expression - `at(yyyy-mm-ddThh:mm:ss)`
	// - `rate` expression - `rate(unit value)`
	// - `cron` expression - `cron(fields)`
	//
	// You can use `at` expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use `rate` and `cron` expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
	//
	// A `cron` expression consists of six fields separated by white spaces: `(minutes hours day_of_month month day_of_week year)` .
	//
	// A `rate` expression consists of a *value* as a positive integer, and a *unit* with the following options: `minute` | `minutes` | `hour` | `hours` | `day` | `days`
	//
	// For more information and examples, see [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .
	ScheduleExpression *string `field:"required" json:"scheduleExpression" yaml:"scheduleExpression"`
	// The schedule's target details.
	Target interface{} `field:"required" json:"target" yaml:"target"`
	// The description you specify for the schedule.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The date, in UTC, before which the schedule can invoke its target.
	//
	// Depending on the schedule's recurrence expression, invocations might stop on, or before, the `EndDate` you specify.
	// EventBridge Scheduler ignores `EndDate` for one-time schedules.
	EndDate *string `field:"optional" json:"endDate" yaml:"endDate"`
	// The name of the schedule group associated with this schedule.
	GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
	// The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
	KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
	// The name of the schedule.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The timezone in which the scheduling expression is evaluated.
	ScheduleExpressionTimezone *string `field:"optional" json:"scheduleExpressionTimezone" yaml:"scheduleExpressionTimezone"`
	// The date, in UTC, after which the schedule can begin invoking its target.
	//
	// Depending on the schedule's recurrence expression, invocations might occur on, or after, the `StartDate` you specify.
	// EventBridge Scheduler ignores `StartDate` for one-time schedules.
	StartDate *string `field:"optional" json:"startDate" yaml:"startDate"`
	// Specifies whether the schedule is enabled or disabled.
	State *string `field:"optional" json:"state" yaml:"state"`
}

Properties for defining a `CfnSchedule`.

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"

var tags interface{}

cfnScheduleProps := &cfnScheduleProps{
	flexibleTimeWindow: &flexibleTimeWindowProperty{
		mode: jsii.String("mode"),

		// the properties below are optional
		maximumWindowInMinutes: jsii.Number(123),
	},
	scheduleExpression: jsii.String("scheduleExpression"),
	target: &targetProperty{
		arn: jsii.String("arn"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		deadLetterConfig: &deadLetterConfigProperty{
			arn: jsii.String("arn"),
		},
		ecsParameters: &ecsParametersProperty{
			taskDefinitionArn: jsii.String("taskDefinitionArn"),

			// the properties below are optional
			capacityProviderStrategy: []interface{}{
				&capacityProviderStrategyItemProperty{
					capacityProvider: jsii.String("capacityProvider"),

					// the properties below are optional
					base: jsii.Number(123),
					weight: jsii.Number(123),
				},
			},
			enableEcsManagedTags: jsii.Boolean(false),
			enableExecuteCommand: jsii.Boolean(false),
			group: jsii.String("group"),
			launchType: jsii.String("launchType"),
			networkConfiguration: &networkConfigurationProperty{
				awsvpcConfiguration: &awsVpcConfigurationProperty{
					subnets: []*string{
						jsii.String("subnets"),
					},

					// the properties below are optional
					assignPublicIp: jsii.String("assignPublicIp"),
					securityGroups: []*string{
						jsii.String("securityGroups"),
					},
				},
			},
			placementConstraints: []interface{}{
				&placementConstraintProperty{
					expression: jsii.String("expression"),
					type: jsii.String("type"),
				},
			},
			placementStrategy: []interface{}{
				&placementStrategyProperty{
					field: jsii.String("field"),
					type: jsii.String("type"),
				},
			},
			platformVersion: jsii.String("platformVersion"),
			propagateTags: jsii.String("propagateTags"),
			referenceId: jsii.String("referenceId"),
			tags: tags,
			taskCount: jsii.Number(123),
		},
		eventBridgeParameters: &eventBridgeParametersProperty{
			detailType: jsii.String("detailType"),
			source: jsii.String("source"),
		},
		input: jsii.String("input"),
		kinesisParameters: &kinesisParametersProperty{
			partitionKey: jsii.String("partitionKey"),
		},
		retryPolicy: &retryPolicyProperty{
			maximumEventAgeInSeconds: jsii.Number(123),
			maximumRetryAttempts: jsii.Number(123),
		},
		sageMakerPipelineParameters: &sageMakerPipelineParametersProperty{
			pipelineParameterList: []interface{}{
				&sageMakerPipelineParameterProperty{
					name: jsii.String("name"),
					value: jsii.String("value"),
				},
			},
		},
		sqsParameters: &sqsParametersProperty{
			messageGroupId: jsii.String("messageGroupId"),
		},
	},

	// the properties below are optional
	description: jsii.String("description"),
	endDate: jsii.String("endDate"),
	groupName: jsii.String("groupName"),
	kmsKeyArn: jsii.String("kmsKeyArn"),
	name: jsii.String("name"),
	scheduleExpressionTimezone: jsii.String("scheduleExpressionTimezone"),
	startDate: jsii.String("startDate"),
	state: jsii.String("state"),
}

type CfnSchedule_AwsVpcConfigurationProperty 

type CfnSchedule_AwsVpcConfigurationProperty struct {
	// Specifies the subnets associated with the task.
	//
	// These subnets must all be in the same VPC. You can specify as many as 16 subnets.
	Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
	// Specifies whether the task's elastic network interface receives a public IP address.
	//
	// You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .
	AssignPublicIp *string `field:"optional" json:"assignPublicIp" yaml:"assignPublicIp"`
	// Specifies the security groups associated with the task.
	//
	// These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
	SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"`
}

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.

This structure is relevant only for ECS tasks that use the awsvpc network mode.

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"

awsVpcConfigurationProperty := &awsVpcConfigurationProperty{
	subnets: []*string{
		jsii.String("subnets"),
	},

	// the properties below are optional
	assignPublicIp: jsii.String("assignPublicIp"),
	securityGroups: []*string{
		jsii.String("securityGroups"),
	},
}

type CfnSchedule_CapacityProviderStrategyItemProperty 

type CfnSchedule_CapacityProviderStrategyItemProperty struct {
	// The short name of the capacity provider.
	CapacityProvider *string `field:"required" json:"capacityProvider" yaml:"capacityProvider"`
	// The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
	//
	// Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of `0` is used.
	Base *float64 `field:"optional" json:"base" yaml:"base"`
	// The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
	//
	// The weight value is taken into consideration after the base value, if defined, is satisfied.
	Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}

The details of a capacity provider strategy.

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"

capacityProviderStrategyItemProperty := &capacityProviderStrategyItemProperty{
	capacityProvider: jsii.String("capacityProvider"),

	// the properties below are optional
	base: jsii.Number(123),
	weight: jsii.Number(123),
}

type CfnSchedule_DeadLetterConfigProperty 

type CfnSchedule_DeadLetterConfigProperty struct {
	// The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
	Arn *string `field:"optional" json:"arn" yaml:"arn"`
}

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.

If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

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"

deadLetterConfigProperty := &deadLetterConfigProperty{
	arn: jsii.String("arn"),
}

type CfnSchedule_EcsParametersProperty 

type CfnSchedule_EcsParametersProperty struct {
	// The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
	TaskDefinitionArn *string `field:"required" json:"taskDefinitionArn" yaml:"taskDefinitionArn"`
	// The capacity provider strategy to use for the task.
	CapacityProviderStrategy interface{} `field:"optional" json:"capacityProviderStrategy" yaml:"capacityProviderStrategy"`
	// Specifies whether to enable Amazon ECS managed tags for the task.
	//
	// For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon ECS Developer Guide* .
	EnableEcsManagedTags interface{} `field:"optional" json:"enableEcsManagedTags" yaml:"enableEcsManagedTags"`
	// Whether or not to enable the execute command functionality for the containers in this task.
	//
	// If true, this enables execute command functionality on all containers in the task.
	EnableExecuteCommand interface{} `field:"optional" json:"enableExecuteCommand" yaml:"enableExecuteCommand"`
	// Specifies an ECS task group for the task.
	//
	// The maximum length is 255 characters.
	Group *string `field:"optional" json:"group" yaml:"group"`
	// Specifies the launch type on which your task is running.
	//
	// The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) in the *Amazon ECS Developer Guide* .
	LaunchType *string `field:"optional" json:"launchType" yaml:"launchType"`
	// This structure specifies the network configuration for an ECS task.
	NetworkConfiguration interface{} `field:"optional" json:"networkConfiguration" yaml:"networkConfiguration"`
	// An array of placement constraint objects to use for the task.
	//
	// You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
	PlacementConstraints interface{} `field:"optional" json:"placementConstraints" yaml:"placementConstraints"`
	// The task placement strategy for a task or service.
	PlacementStrategy interface{} `field:"optional" json:"placementStrategy" yaml:"placementStrategy"`
	// Specifies the platform version for the task.
	//
	// Specify only the numeric portion of the platform version, such as `1.1.0` .
	PlatformVersion *string `field:"optional" json:"platformVersion" yaml:"platformVersion"`
	// Specifies whether to propagate the tags from the task definition to the task.
	//
	// If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's [`TagResource`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
	PropagateTags *string `field:"optional" json:"propagateTags" yaml:"propagateTags"`
	// The reference ID to use for the task.
	ReferenceId *string `field:"optional" json:"referenceId" yaml:"referenceId"`
	// The metadata that you apply to the task to help you categorize and organize them.
	//
	// Each tag consists of a key and an optional value, both of which you define. For more information, see [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) in the *Amazon ECS API Reference* .
	Tags interface{} `field:"optional" json:"tags" yaml:"tags"`
	// The number of tasks to create based on `TaskDefinition` .
	//
	// The default is `1` .
	TaskCount *float64 `field:"optional" json:"taskCount" yaml:"taskCount"`
}

The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.

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"

var tags interface{}

ecsParametersProperty := &ecsParametersProperty{
	taskDefinitionArn: jsii.String("taskDefinitionArn"),

	// the properties below are optional
	capacityProviderStrategy: []interface{}{
		&capacityProviderStrategyItemProperty{
			capacityProvider: jsii.String("capacityProvider"),

			// the properties below are optional
			base: jsii.Number(123),
			weight: jsii.Number(123),
		},
	},
	enableEcsManagedTags: jsii.Boolean(false),
	enableExecuteCommand: jsii.Boolean(false),
	group: jsii.String("group"),
	launchType: jsii.String("launchType"),
	networkConfiguration: &networkConfigurationProperty{
		awsvpcConfiguration: &awsVpcConfigurationProperty{
			subnets: []*string{
				jsii.String("subnets"),
			},

			// the properties below are optional
			assignPublicIp: jsii.String("assignPublicIp"),
			securityGroups: []*string{
				jsii.String("securityGroups"),
			},
		},
	},
	placementConstraints: []interface{}{
		&placementConstraintProperty{
			expression: jsii.String("expression"),
			type: jsii.String("type"),
		},
	},
	placementStrategy: []interface{}{
		&placementStrategyProperty{
			field: jsii.String("field"),
			type: jsii.String("type"),
		},
	},
	platformVersion: jsii.String("platformVersion"),
	propagateTags: jsii.String("propagateTags"),
	referenceId: jsii.String("referenceId"),
	tags: tags,
	taskCount: jsii.Number(123),
}

type CfnSchedule_EventBridgeParametersProperty 

type CfnSchedule_EventBridgeParametersProperty struct {
	// A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
	DetailType *string `field:"required" json:"detailType" yaml:"detailType"`
	// The source of the event.
	Source *string `field:"required" json:"source" yaml:"source"`
}

The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.

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"

eventBridgeParametersProperty := &eventBridgeParametersProperty{
	detailType: jsii.String("detailType"),
	source: jsii.String("source"),
}

type CfnSchedule_FlexibleTimeWindowProperty 

type CfnSchedule_FlexibleTimeWindowProperty struct {
	// Determines whether the schedule is invoked within a flexible time window.
	Mode *string `field:"required" json:"mode" yaml:"mode"`
	// The maximum time window during which a schedule can be invoked.
	MaximumWindowInMinutes *float64 `field:"optional" json:"maximumWindowInMinutes" yaml:"maximumWindowInMinutes"`
}

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

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"

flexibleTimeWindowProperty := &flexibleTimeWindowProperty{
	mode: jsii.String("mode"),

	// the properties below are optional
	maximumWindowInMinutes: jsii.Number(123),
}

type CfnSchedule_KinesisParametersProperty 

type CfnSchedule_KinesisParametersProperty struct {
	// Specifies the shard to which EventBridge Scheduler sends the event.
	//
	// For more information, see [Amazon Kinesis Data Streams terminology and concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) in the *Amazon Kinesis Streams Developer Guide* .
	PartitionKey *string `field:"required" json:"partitionKey" yaml:"partitionKey"`
}

The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.

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"

kinesisParametersProperty := &kinesisParametersProperty{
	partitionKey: jsii.String("partitionKey"),
}

type CfnSchedule_NetworkConfigurationProperty 

type CfnSchedule_NetworkConfigurationProperty struct {
	// Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used.
	//
	// This structure is relevant only for ECS tasks that use the awsvpc network mode.
	AwsvpcConfiguration interface{} `field:"optional" json:"awsvpcConfiguration" yaml:"awsvpcConfiguration"`
}

Specifies the network configuration for an ECS task.

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"

networkConfigurationProperty := &networkConfigurationProperty{
	awsvpcConfiguration: &awsVpcConfigurationProperty{
		subnets: []*string{
			jsii.String("subnets"),
		},

		// the properties below are optional
		assignPublicIp: jsii.String("assignPublicIp"),
		securityGroups: []*string{
			jsii.String("securityGroups"),
		},
	},
}

type CfnSchedule_PlacementConstraintProperty 

type CfnSchedule_PlacementConstraintProperty struct {
	// A cluster query language expression to apply to the constraint.
	//
	// You cannot specify an expression if the constraint type is `distinctInstance` . For more information, see [Cluster query language](https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html) in the *Amazon ECS Developer Guide* .
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// The type of constraint.
	//
	// Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates.
	Type *string `field:"optional" json:"type" yaml:"type"`
}

An object representing a constraint on task placement.

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"

placementConstraintProperty := &placementConstraintProperty{
	expression: jsii.String("expression"),
	type: jsii.String("type"),
}

type CfnSchedule_PlacementStrategyProperty 

type CfnSchedule_PlacementStrategyProperty struct {
	// The field to apply the placement strategy against.
	//
	// For the spread placement strategy, valid values are `instanceId` (or `instanceId` , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as `attribute:ecs.availability-zone` . For the binpack placement strategy, valid values are `cpu` and `memory` . For the random placement strategy, this field is not used.
	Field *string `field:"optional" json:"field" yaml:"field"`
	// The type of placement strategy.
	//
	// The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
	Type *string `field:"optional" json:"type" yaml:"type"`
}

The task placement strategy for a task or service.

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"

placementStrategyProperty := &placementStrategyProperty{
	field: jsii.String("field"),
	type: jsii.String("type"),
}

type CfnSchedule_RetryPolicyProperty 

type CfnSchedule_RetryPolicyProperty struct {
	// The maximum amount of time, in seconds, to continue to make retry attempts.
	MaximumEventAgeInSeconds *float64 `field:"optional" json:"maximumEventAgeInSeconds" yaml:"maximumEventAgeInSeconds"`
	// The maximum number of retry attempts to make before the request fails.
	//
	// Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is reached.
	MaximumRetryAttempts *float64 `field:"optional" json:"maximumRetryAttempts" yaml:"maximumRetryAttempts"`
}

A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

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"

retryPolicyProperty := &retryPolicyProperty{
	maximumEventAgeInSeconds: jsii.Number(123),
	maximumRetryAttempts: jsii.Number(123),
}

type CfnSchedule_SageMakerPipelineParameterProperty 

type CfnSchedule_SageMakerPipelineParameterProperty struct {
	// Name of parameter to start execution of a SageMaker Model Building Pipeline.
	Name *string `field:"required" json:"name" yaml:"name"`
	// Value of parameter to start execution of a SageMaker Model Building Pipeline.
	Value *string `field:"required" json:"value" yaml:"value"`
}

The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.

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"

sageMakerPipelineParameterProperty := &sageMakerPipelineParameterProperty{
	name: jsii.String("name"),
	value: jsii.String("value"),
}

type CfnSchedule_SageMakerPipelineParametersProperty 

type CfnSchedule_SageMakerPipelineParametersProperty struct {
	// List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
	PipelineParameterList interface{} `field:"optional" json:"pipelineParameterList" yaml:"pipelineParameterList"`
}

The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.

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"

sageMakerPipelineParametersProperty := &sageMakerPipelineParametersProperty{
	pipelineParameterList: []interface{}{
		&sageMakerPipelineParameterProperty{
			name: jsii.String("name"),
			value: jsii.String("value"),
		},
	},
}

type CfnSchedule_SqsParametersProperty 

type CfnSchedule_SqsParametersProperty struct {
	// The FIFO message group ID to use as the target.
	MessageGroupId *string `field:"optional" json:"messageGroupId" yaml:"messageGroupId"`
}

The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide* .

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"

sqsParametersProperty := &sqsParametersProperty{
	messageGroupId: jsii.String("messageGroupId"),
}

type CfnSchedule_TargetProperty 

type CfnSchedule_TargetProperty struct {
	// The Amazon Resource Name (ARN) of the target.
	Arn *string `field:"required" json:"arn" yaml:"arn"`
	// The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
	//
	// If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
	DeadLetterConfig interface{} `field:"optional" json:"deadLetterConfig" yaml:"deadLetterConfig"`
	// The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.
	EcsParameters interface{} `field:"optional" json:"ecsParameters" yaml:"ecsParameters"`
	// The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.
	EventBridgeParameters interface{} `field:"optional" json:"eventBridgeParameters" yaml:"eventBridgeParameters"`
	// The text, or well-formed JSON, passed to the target.
	//
	// If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.
	Input *string `field:"optional" json:"input" yaml:"input"`
	// The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.
	KinesisParameters interface{} `field:"optional" json:"kinesisParameters" yaml:"kinesisParameters"`
	// A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
	RetryPolicy interface{} `field:"optional" json:"retryPolicy" yaml:"retryPolicy"`
	// The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.
	SageMakerPipelineParameters interface{} `field:"optional" json:"sageMakerPipelineParameters" yaml:"sageMakerPipelineParameters"`
	// The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide* .
	SqsParameters interface{} `field:"optional" json:"sqsParameters" yaml:"sqsParameters"`
}

The schedule's target.

EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

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"

var tags interface{}

targetProperty := &targetProperty{
	arn: jsii.String("arn"),
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	deadLetterConfig: &deadLetterConfigProperty{
		arn: jsii.String("arn"),
	},
	ecsParameters: &ecsParametersProperty{
		taskDefinitionArn: jsii.String("taskDefinitionArn"),

		// the properties below are optional
		capacityProviderStrategy: []interface{}{
			&capacityProviderStrategyItemProperty{
				capacityProvider: jsii.String("capacityProvider"),

				// the properties below are optional
				base: jsii.Number(123),
				weight: jsii.Number(123),
			},
		},
		enableEcsManagedTags: jsii.Boolean(false),
		enableExecuteCommand: jsii.Boolean(false),
		group: jsii.String("group"),
		launchType: jsii.String("launchType"),
		networkConfiguration: &networkConfigurationProperty{
			awsvpcConfiguration: &awsVpcConfigurationProperty{
				subnets: []*string{
					jsii.String("subnets"),
				},

				// the properties below are optional
				assignPublicIp: jsii.String("assignPublicIp"),
				securityGroups: []*string{
					jsii.String("securityGroups"),
				},
			},
		},
		placementConstraints: []interface{}{
			&placementConstraintProperty{
				expression: jsii.String("expression"),
				type: jsii.String("type"),
			},
		},
		placementStrategy: []interface{}{
			&placementStrategyProperty{
				field: jsii.String("field"),
				type: jsii.String("type"),
			},
		},
		platformVersion: jsii.String("platformVersion"),
		propagateTags: jsii.String("propagateTags"),
		referenceId: jsii.String("referenceId"),
		tags: tags,
		taskCount: jsii.Number(123),
	},
	eventBridgeParameters: &eventBridgeParametersProperty{
		detailType: jsii.String("detailType"),
		source: jsii.String("source"),
	},
	input: jsii.String("input"),
	kinesisParameters: &kinesisParametersProperty{
		partitionKey: jsii.String("partitionKey"),
	},
	retryPolicy: &retryPolicyProperty{
		maximumEventAgeInSeconds: jsii.Number(123),
		maximumRetryAttempts: jsii.Number(123),
	},
	sageMakerPipelineParameters: &sageMakerPipelineParametersProperty{
		pipelineParameterList: []interface{}{
			&sageMakerPipelineParameterProperty{
				name: jsii.String("name"),
				value: jsii.String("value"),
			},
		},
	},
	sqsParameters: &sqsParametersProperty{
		messageGroupId: jsii.String("messageGroupId"),
	},
}

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.