Documentation ¶
Index ¶
- func CfnScheduleGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScheduleGroup_IsCfnElement(x interface{}) *bool
- func CfnScheduleGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnScheduleGroup_IsConstruct(x interface{}) *bool
- func CfnSchedule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchedule_IsCfnElement(x interface{}) *bool
- func CfnSchedule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSchedule_IsConstruct(x interface{}) *bool
- func NewCfnScheduleGroup_Override(c CfnScheduleGroup, scope constructs.Construct, id *string, ...)
- func NewCfnSchedule_Override(c CfnSchedule, scope constructs.Construct, id *string, props *CfnScheduleProps)
- type CfnSchedule
- type CfnScheduleGroup
- type CfnScheduleGroupProps
- type CfnScheduleProps
- type CfnSchedule_AwsVpcConfigurationProperty
- type CfnSchedule_CapacityProviderStrategyItemProperty
- type CfnSchedule_DeadLetterConfigProperty
- type CfnSchedule_EcsParametersProperty
- type CfnSchedule_EventBridgeParametersProperty
- type CfnSchedule_FlexibleTimeWindowProperty
- type CfnSchedule_KinesisParametersProperty
- type CfnSchedule_NetworkConfigurationProperty
- type CfnSchedule_PlacementConstraintProperty
- type CfnSchedule_PlacementStrategyProperty
- type CfnSchedule_RetryPolicyProperty
- type CfnSchedule_SageMakerPipelineParameterProperty
- type CfnSchedule_SageMakerPipelineParametersProperty
- type CfnSchedule_SqsParametersProperty
- type CfnSchedule_TargetProperty
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 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 // `AWS::Scheduler::Schedule.Description`. Description() *string SetDescription(val *string) // `AWS::Scheduler::Schedule.EndDate`. EndDate() *string SetEndDate(val *string) // `AWS::Scheduler::Schedule.FlexibleTimeWindow`. FlexibleTimeWindow() interface{} SetFlexibleTimeWindow(val interface{}) // `AWS::Scheduler::Schedule.GroupName`. GroupName() *string SetGroupName(val *string) // `AWS::Scheduler::Schedule.KmsKeyArn`. 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 // `AWS::Scheduler::Schedule.Name`. 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 // `AWS::Scheduler::Schedule.ScheduleExpression`. ScheduleExpression() *string SetScheduleExpression(val *string) // `AWS::Scheduler::Schedule.ScheduleExpressionTimezone`. 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 // `AWS::Scheduler::Schedule.StartDate`. StartDate() *string SetStartDate(val *string) // `AWS::Scheduler::Schedule.State`. State() *string SetState(val *string) // `AWS::Scheduler::Schedule.Target`. 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`.
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 AttrArn() *string AttrCreationDate() *string AttrLastModificationDate() *string 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 // `AWS::Scheduler::ScheduleGroup.Name`. 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 // `AWS::Scheduler::ScheduleGroup.Tags`. 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`.
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 { // `AWS::Scheduler::ScheduleGroup.Name`. Name *string `field:"optional" json:"name" yaml:"name"` // `AWS::Scheduler::ScheduleGroup.Tags`. 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 { // `AWS::Scheduler::Schedule.FlexibleTimeWindow`. FlexibleTimeWindow interface{} `field:"required" json:"flexibleTimeWindow" yaml:"flexibleTimeWindow"` // `AWS::Scheduler::Schedule.ScheduleExpression`. ScheduleExpression *string `field:"required" json:"scheduleExpression" yaml:"scheduleExpression"` // `AWS::Scheduler::Schedule.Target`. Target interface{} `field:"required" json:"target" yaml:"target"` // `AWS::Scheduler::Schedule.Description`. Description *string `field:"optional" json:"description" yaml:"description"` // `AWS::Scheduler::Schedule.EndDate`. EndDate *string `field:"optional" json:"endDate" yaml:"endDate"` // `AWS::Scheduler::Schedule.GroupName`. GroupName *string `field:"optional" json:"groupName" yaml:"groupName"` // `AWS::Scheduler::Schedule.KmsKeyArn`. KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` // `AWS::Scheduler::Schedule.Name`. Name *string `field:"optional" json:"name" yaml:"name"` // `AWS::Scheduler::Schedule.ScheduleExpressionTimezone`. ScheduleExpressionTimezone *string `field:"optional" json:"scheduleExpressionTimezone" yaml:"scheduleExpressionTimezone"` // `AWS::Scheduler::Schedule.StartDate`. StartDate *string `field:"optional" json:"startDate" yaml:"startDate"` // `AWS::Scheduler::Schedule.State`. 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 { // `CfnSchedule.AwsVpcConfigurationProperty.Subnets`. Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` // `CfnSchedule.AwsVpcConfigurationProperty.AssignPublicIp`. AssignPublicIp *string `field:"optional" json:"assignPublicIp" yaml:"assignPublicIp"` // `CfnSchedule.AwsVpcConfigurationProperty.SecurityGroups`. SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"` }
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 { // `CfnSchedule.CapacityProviderStrategyItemProperty.CapacityProvider`. CapacityProvider *string `field:"required" json:"capacityProvider" yaml:"capacityProvider"` // `CfnSchedule.CapacityProviderStrategyItemProperty.Base`. Base *float64 `field:"optional" json:"base" yaml:"base"` // `CfnSchedule.CapacityProviderStrategyItemProperty.Weight`. Weight *float64 `field:"optional" json:"weight" yaml:"weight"` }
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 { // `CfnSchedule.DeadLetterConfigProperty.Arn`. Arn *string `field:"optional" json:"arn" yaml:"arn"` }
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 { // `CfnSchedule.EcsParametersProperty.TaskDefinitionArn`. TaskDefinitionArn *string `field:"required" json:"taskDefinitionArn" yaml:"taskDefinitionArn"` // `CfnSchedule.EcsParametersProperty.CapacityProviderStrategy`. CapacityProviderStrategy interface{} `field:"optional" json:"capacityProviderStrategy" yaml:"capacityProviderStrategy"` // `CfnSchedule.EcsParametersProperty.EnableECSManagedTags`. EnableEcsManagedTags interface{} `field:"optional" json:"enableEcsManagedTags" yaml:"enableEcsManagedTags"` // `CfnSchedule.EcsParametersProperty.EnableExecuteCommand`. EnableExecuteCommand interface{} `field:"optional" json:"enableExecuteCommand" yaml:"enableExecuteCommand"` // `CfnSchedule.EcsParametersProperty.Group`. Group *string `field:"optional" json:"group" yaml:"group"` // `CfnSchedule.EcsParametersProperty.LaunchType`. LaunchType *string `field:"optional" json:"launchType" yaml:"launchType"` // `CfnSchedule.EcsParametersProperty.NetworkConfiguration`. NetworkConfiguration interface{} `field:"optional" json:"networkConfiguration" yaml:"networkConfiguration"` // `CfnSchedule.EcsParametersProperty.PlacementConstraints`. PlacementConstraints interface{} `field:"optional" json:"placementConstraints" yaml:"placementConstraints"` // `CfnSchedule.EcsParametersProperty.PlacementStrategy`. PlacementStrategy interface{} `field:"optional" json:"placementStrategy" yaml:"placementStrategy"` // `CfnSchedule.EcsParametersProperty.PlatformVersion`. PlatformVersion *string `field:"optional" json:"platformVersion" yaml:"platformVersion"` // `CfnSchedule.EcsParametersProperty.PropagateTags`. PropagateTags *string `field:"optional" json:"propagateTags" yaml:"propagateTags"` // `CfnSchedule.EcsParametersProperty.ReferenceId`. ReferenceId *string `field:"optional" json:"referenceId" yaml:"referenceId"` // `CfnSchedule.EcsParametersProperty.Tags`. Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // `CfnSchedule.EcsParametersProperty.TaskCount`. TaskCount *float64 `field:"optional" json:"taskCount" yaml:"taskCount"` }
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 { // `CfnSchedule.EventBridgeParametersProperty.DetailType`. DetailType *string `field:"required" json:"detailType" yaml:"detailType"` // `CfnSchedule.EventBridgeParametersProperty.Source`. Source *string `field:"required" json:"source" yaml:"source"` }
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 { // `CfnSchedule.FlexibleTimeWindowProperty.Mode`. Mode *string `field:"required" json:"mode" yaml:"mode"` // `CfnSchedule.FlexibleTimeWindowProperty.MaximumWindowInMinutes`. MaximumWindowInMinutes *float64 `field:"optional" json:"maximumWindowInMinutes" yaml:"maximumWindowInMinutes"` }
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 { // `CfnSchedule.KinesisParametersProperty.PartitionKey`. PartitionKey *string `field:"required" json:"partitionKey" yaml:"partitionKey"` }
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 {
// `CfnSchedule.NetworkConfigurationProperty.AwsvpcConfiguration`.
AwsvpcConfiguration interface{} `field:"optional" json:"awsvpcConfiguration" yaml:"awsvpcConfiguration"`
}
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 { // `CfnSchedule.PlacementConstraintProperty.Expression`. Expression *string `field:"optional" json:"expression" yaml:"expression"` // `CfnSchedule.PlacementConstraintProperty.Type`. Type *string `field:"optional" json:"type" yaml:"type"` }
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 { // `CfnSchedule.PlacementStrategyProperty.Field`. Field *string `field:"optional" json:"field" yaml:"field"` // `CfnSchedule.PlacementStrategyProperty.Type`. Type *string `field:"optional" json:"type" yaml:"type"` }
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 { // `CfnSchedule.RetryPolicyProperty.MaximumEventAgeInSeconds`. MaximumEventAgeInSeconds *float64 `field:"optional" json:"maximumEventAgeInSeconds" yaml:"maximumEventAgeInSeconds"` // `CfnSchedule.RetryPolicyProperty.MaximumRetryAttempts`. MaximumRetryAttempts *float64 `field:"optional" json:"maximumRetryAttempts" yaml:"maximumRetryAttempts"` }
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 { // `CfnSchedule.SageMakerPipelineParameterProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `CfnSchedule.SageMakerPipelineParameterProperty.Value`. Value *string `field:"required" json:"value" yaml:"value"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sageMakerPipelineParameterProperty := &sageMakerPipelineParameterProperty{ name: jsii.String("name"), value: jsii.String("value"), }
type CfnSchedule_SageMakerPipelineParametersProperty ¶
type CfnSchedule_SageMakerPipelineParametersProperty struct {
// `CfnSchedule.SageMakerPipelineParametersProperty.PipelineParameterList`.
PipelineParameterList interface{} `field:"optional" json:"pipelineParameterList" yaml:"pipelineParameterList"`
}
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 { // `CfnSchedule.SqsParametersProperty.MessageGroupId`. MessageGroupId *string `field:"optional" json:"messageGroupId" yaml:"messageGroupId"` }
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 { // `CfnSchedule.TargetProperty.Arn`. Arn *string `field:"required" json:"arn" yaml:"arn"` // `CfnSchedule.TargetProperty.RoleArn`. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // `CfnSchedule.TargetProperty.DeadLetterConfig`. DeadLetterConfig interface{} `field:"optional" json:"deadLetterConfig" yaml:"deadLetterConfig"` // `CfnSchedule.TargetProperty.EcsParameters`. EcsParameters interface{} `field:"optional" json:"ecsParameters" yaml:"ecsParameters"` // `CfnSchedule.TargetProperty.EventBridgeParameters`. EventBridgeParameters interface{} `field:"optional" json:"eventBridgeParameters" yaml:"eventBridgeParameters"` // `CfnSchedule.TargetProperty.Input`. Input *string `field:"optional" json:"input" yaml:"input"` // `CfnSchedule.TargetProperty.KinesisParameters`. KinesisParameters interface{} `field:"optional" json:"kinesisParameters" yaml:"kinesisParameters"` // `CfnSchedule.TargetProperty.RetryPolicy`. RetryPolicy interface{} `field:"optional" json:"retryPolicy" yaml:"retryPolicy"` // `CfnSchedule.TargetProperty.SageMakerPipelineParameters`. SageMakerPipelineParameters interface{} `field:"optional" json:"sageMakerPipelineParameters" yaml:"sageMakerPipelineParameters"` // `CfnSchedule.TargetProperty.SqsParameters`. SqsParameters interface{} `field:"optional" json:"sqsParameters" yaml:"sqsParameters"` }
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 ¶
- awsscheduler.go
- awsscheduler_CfnSchedule.go
- awsscheduler_CfnScheduleGroup.go
- awsscheduler_CfnScheduleGroupProps.go
- awsscheduler_CfnScheduleGroup__runtime_type_checks.go
- awsscheduler_CfnScheduleProps.go
- awsscheduler_CfnSchedule_AwsVpcConfigurationProperty.go
- awsscheduler_CfnSchedule_CapacityProviderStrategyItemProperty.go
- awsscheduler_CfnSchedule_DeadLetterConfigProperty.go
- awsscheduler_CfnSchedule_EcsParametersProperty.go
- awsscheduler_CfnSchedule_EventBridgeParametersProperty.go
- awsscheduler_CfnSchedule_FlexibleTimeWindowProperty.go
- awsscheduler_CfnSchedule_KinesisParametersProperty.go
- awsscheduler_CfnSchedule_NetworkConfigurationProperty.go
- awsscheduler_CfnSchedule_PlacementConstraintProperty.go
- awsscheduler_CfnSchedule_PlacementStrategyProperty.go
- awsscheduler_CfnSchedule_RetryPolicyProperty.go
- awsscheduler_CfnSchedule_SageMakerPipelineParameterProperty.go
- awsscheduler_CfnSchedule_SageMakerPipelineParametersProperty.go
- awsscheduler_CfnSchedule_SqsParametersProperty.go
- awsscheduler_CfnSchedule_TargetProperty.go
- awsscheduler_CfnSchedule__runtime_type_checks.go