Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. scheduler
  5. ScheduleGroup
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.scheduler.ScheduleGroup

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an EventBridge Scheduler Schedule Group resource.

    You can find out more about EventBridge Scheduler in the User Guide.

    Note: EventBridge was formerly known as CloudWatch Events. The functionality is identical.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.scheduler.ScheduleGroup("example", {name: "my-schedule-group"});

    import pulumi
import pulumi_aws as aws

example = aws.scheduler.ScheduleGroup("example", name="my-schedule-group")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/scheduler"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scheduler.NewScheduleGroup(ctx, "example", &scheduler.ScheduleGroupArgs{
			Name: pulumi.String("my-schedule-group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Scheduler.ScheduleGroup("example", new()
    {
        Name = "my-schedule-group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.scheduler.ScheduleGroup;
import com.pulumi.aws.scheduler.ScheduleGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ScheduleGroup("example", ScheduleGroupArgs.builder()
            .name("my-schedule-group")
            .build());

    }
}

    resources:
  example:
    type: aws:scheduler:ScheduleGroup
    properties:
      name: my-schedule-group

    Create ScheduleGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduleGroup(name: string, args?: ScheduleGroupArgs, opts?: CustomResourceOptions);
    @overload
def ScheduleGroup(resource_name: str,
                  args: Optional[ScheduleGroupArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def ScheduleGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  name_prefix: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewScheduleGroup(ctx *Context, name string, args *ScheduleGroupArgs, opts ...ResourceOption) (*ScheduleGroup, error)
    public ScheduleGroup(string name, ScheduleGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ScheduleGroup(String name, ScheduleGroupArgs args)
public ScheduleGroup(String name, ScheduleGroupArgs args, CustomResourceOptions options)

    type: aws:scheduler:ScheduleGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScheduleGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduleGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduleGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduleGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduleGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scheduleGroupResource = new Aws.Scheduler.ScheduleGroup("scheduleGroupResource", new()
{
    Name = "string",
    NamePrefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := scheduler.NewScheduleGroup(ctx, "scheduleGroupResource", &scheduler.ScheduleGroupArgs{
	Name:       pulumi.String("string"),
	NamePrefix: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var scheduleGroupResource = new ScheduleGroup("scheduleGroupResource", ScheduleGroupArgs.builder()
    .name("string")
    .namePrefix("string")
    .tags(Map.of("string", "string"))
    .build());

    schedule_group_resource = aws.scheduler.ScheduleGroup("scheduleGroupResource",
    name="string",
    name_prefix="string",
    tags={
        "string": "string",
    })

    const scheduleGroupResource = new aws.scheduler.ScheduleGroup("scheduleGroupResource", {
    name: "string",
    namePrefix: "string",
    tags: {
        string: "string",
    },
});

    type: aws:scheduler:ScheduleGroup
properties:
    name: string
    namePrefix: string
    tags:
        string: string

    ScheduleGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScheduleGroup resource accepts the following input properties:

    Name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name str
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduleGroup resource produces the following output properties:

    Arn string
    ARN of the schedule group.
    CreationDate string
    Time at which the schedule group was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModificationDate string
    Time at which the schedule group was last modified.
    State string
    State of the schedule group. Can be ACTIVE or DELETING.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the schedule group.
    CreationDate string
    Time at which the schedule group was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModificationDate string
    Time at which the schedule group was last modified.
    State string
    State of the schedule group. Can be ACTIVE or DELETING.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the schedule group.
    creationDate String
    Time at which the schedule group was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModificationDate String
    Time at which the schedule group was last modified.
    state String
    State of the schedule group. Can be ACTIVE or DELETING.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the schedule group.
    creationDate string
    Time at which the schedule group was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModificationDate string
    Time at which the schedule group was last modified.
    state string
    State of the schedule group. Can be ACTIVE or DELETING.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the schedule group.
    creation_date str
    Time at which the schedule group was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modification_date str
    Time at which the schedule group was last modified.
    state str
    State of the schedule group. Can be ACTIVE or DELETING.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the schedule group.
    creationDate String
    Time at which the schedule group was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModificationDate String
    Time at which the schedule group was last modified.
    state String
    State of the schedule group. Can be ACTIVE or DELETING.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ScheduleGroup Resource

    Get an existing ScheduleGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScheduleGroupState, opts?: CustomResourceOptions): ScheduleGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        creation_date: Optional[str] = None,
        last_modification_date: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ScheduleGroup
    func GetScheduleGroup(ctx *Context, name string, id IDInput, state *ScheduleGroupState, opts ...ResourceOption) (*ScheduleGroup, error)
    public static ScheduleGroup Get(string name, Input<string> id, ScheduleGroupState? state, CustomResourceOptions? opts = null)
    public static ScheduleGroup get(String name, Output<String> id, ScheduleGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the schedule group.
    CreationDate string
    Time at which the schedule group was created.
    LastModificationDate string
    Time at which the schedule group was last modified.
    Name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    State string
    State of the schedule group. Can be ACTIVE or DELETING.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the schedule group.
    CreationDate string
    Time at which the schedule group was created.
    LastModificationDate string
    Time at which the schedule group was last modified.
    Name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    State string
    State of the schedule group. Can be ACTIVE or DELETING.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the schedule group.
    creationDate String
    Time at which the schedule group was created.
    lastModificationDate String
    Time at which the schedule group was last modified.
    name String
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    state String
    State of the schedule group. Can be ACTIVE or DELETING.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the schedule group.
    creationDate string
    Time at which the schedule group was created.
    lastModificationDate string
    Time at which the schedule group was last modified.
    name string
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    state string
    State of the schedule group. Can be ACTIVE or DELETING.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the schedule group.
    creation_date str
    Time at which the schedule group was created.
    last_modification_date str
    Time at which the schedule group was last modified.
    name str
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    state str
    State of the schedule group. Can be ACTIVE or DELETING.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the schedule group.
    creationDate String
    Time at which the schedule group was created.
    lastModificationDate String
    Time at which the schedule group was last modified.
    name String
    Name of the schedule group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    state String
    State of the schedule group. Can be ACTIVE or DELETING.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import schedule groups using the name. For example:

    $ pulumi import aws:scheduler/scheduleGroup:ScheduleGroup example my-schedule-group

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws