Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sfn
  5. Activity
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sfn.Activity

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Step Function Activity resource

    Example Usage

    Basic

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

const sfnActivity = new aws.sfn.Activity("sfn_activity", {name: "my-activity"});

    import pulumi
import pulumi_aws as aws

sfn_activity = aws.sfn.Activity("sfn_activity", name="my-activity")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewActivity(ctx, "sfn_activity", &sfn.ActivityArgs{
			Name: pulumi.String("my-activity"),
		})
		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 sfnActivity = new Aws.Sfn.Activity("sfn_activity", new()
    {
        Name = "my-activity",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sfn.Activity;
import com.pulumi.aws.sfn.ActivityArgs;
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 sfnActivity = new Activity("sfnActivity", ActivityArgs.builder()
            .name("my-activity")
            .build());

    }
}

    resources:
  sfnActivity:
    type: aws:sfn:Activity
    name: sfn_activity
    properties:
      name: my-activity

    Encryption

    NOTE: See the section Data at rest encyption in the AWS Step Functions Developer Guide for more information about enabling encryption of data using a customer-managed key for Step Functions State Machines data.

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

const sfnActivity = new aws.sfn.Activity("sfn_activity", {
    name: "my-activity",
    encryptionConfiguration: {
        kmsKeyId: kmsKeyForSfn.arn,
        type: "CUSTOMER_MANAGED_KMS_KEY",
        kmsDataKeyReusePeriodSeconds: 900,
    },
});

    import pulumi
import pulumi_aws as aws

sfn_activity = aws.sfn.Activity("sfn_activity",
    name="my-activity",
    encryption_configuration={
        "kms_key_id": kms_key_for_sfn["arn"],
        "type": "CUSTOMER_MANAGED_KMS_KEY",
        "kms_data_key_reuse_period_seconds": 900,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewActivity(ctx, "sfn_activity", &sfn.ActivityArgs{
			Name: pulumi.String("my-activity"),
			EncryptionConfiguration: &sfn.ActivityEncryptionConfigurationArgs{
				KmsKeyId:                     pulumi.Any(kmsKeyForSfn.Arn),
				Type:                         pulumi.String("CUSTOMER_MANAGED_KMS_KEY"),
				KmsDataKeyReusePeriodSeconds: pulumi.Int(900),
			},
		})
		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 sfnActivity = new Aws.Sfn.Activity("sfn_activity", new()
    {
        Name = "my-activity",
        EncryptionConfiguration = new Aws.Sfn.Inputs.ActivityEncryptionConfigurationArgs
        {
            KmsKeyId = kmsKeyForSfn.Arn,
            Type = "CUSTOMER_MANAGED_KMS_KEY",
            KmsDataKeyReusePeriodSeconds = 900,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sfn.Activity;
import com.pulumi.aws.sfn.ActivityArgs;
import com.pulumi.aws.sfn.inputs.ActivityEncryptionConfigurationArgs;
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 sfnActivity = new Activity("sfnActivity", ActivityArgs.builder()
            .name("my-activity")
            .encryptionConfiguration(ActivityEncryptionConfigurationArgs.builder()
                .kmsKeyId(kmsKeyForSfn.arn())
                .type("CUSTOMER_MANAGED_KMS_KEY")
                .kmsDataKeyReusePeriodSeconds(900)
                .build())
            .build());

    }
}

    resources:
  sfnActivity:
    type: aws:sfn:Activity
    name: sfn_activity
    properties:
      name: my-activity
      encryptionConfiguration:
        kmsKeyId: ${kmsKeyForSfn.arn}
        type: CUSTOMER_MANAGED_KMS_KEY
        kmsDataKeyReusePeriodSeconds: 900

    Create Activity Resource

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

    Constructor syntax

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

@overload
def Activity(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             encryption_configuration: Optional[ActivityEncryptionConfigurationArgs] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewActivity(ctx *Context, name string, args *ActivityArgs, opts ...ResourceOption) (*Activity, error)
    public Activity(string name, ActivityArgs? args = null, CustomResourceOptions? opts = null)
    public Activity(String name, ActivityArgs args)
public Activity(String name, ActivityArgs args, CustomResourceOptions options)

    type: aws:sfn:Activity
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 ActivityArgs
    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 ActivityArgs
    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 ActivityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActivityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActivityArgs
    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 activityResource = new Aws.Sfn.Activity("activityResource", new()
{
    EncryptionConfiguration = new Aws.Sfn.Inputs.ActivityEncryptionConfigurationArgs
    {
        KmsDataKeyReusePeriodSeconds = 0,
        KmsKeyId = "string",
        Type = "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sfn.NewActivity(ctx, "activityResource", &sfn.ActivityArgs{
	EncryptionConfiguration: &sfn.ActivityEncryptionConfigurationArgs{
		KmsDataKeyReusePeriodSeconds: pulumi.Int(0),
		KmsKeyId:                     pulumi.String("string"),
		Type:                         pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var activityResource = new Activity("activityResource", ActivityArgs.builder()
    .encryptionConfiguration(ActivityEncryptionConfigurationArgs.builder()
        .kmsDataKeyReusePeriodSeconds(0)
        .kmsKeyId("string")
        .type("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    activity_resource = aws.sfn.Activity("activityResource",
    encryption_configuration={
        "kms_data_key_reuse_period_seconds": 0,
        "kms_key_id": "string",
        "type": "string",
    },
    name="string",
    tags={
        "string": "string",
    })

    const activityResource = new aws.sfn.Activity("activityResource", {
    encryptionConfiguration: {
        kmsDataKeyReusePeriodSeconds: 0,
        kmsKeyId: "string",
        type: "string",
    },
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:sfn:Activity
properties:
    encryptionConfiguration:
        kmsDataKeyReusePeriodSeconds: 0
        kmsKeyId: string
        type: string
    name: string
    tags:
        string: string

    Activity Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Activity resource accepts the following input properties:

    EncryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    Name string
    The name of the activity to create.
    Tags Dictionary<string, string>
    Key-value map 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.
    EncryptionConfiguration ActivityEncryptionConfigurationArgs
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    Name string
    The name of the activity to create.
    Tags map[string]string
    Key-value map 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.
    encryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name String
    The name of the activity to create.
    tags Map<String,String>
    Key-value map 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.
    encryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name string
    The name of the activity to create.
    tags {[key: string]: string}
    Key-value map 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.
    encryption_configuration ActivityEncryptionConfigurationArgs
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name str
    The name of the activity to create.
    tags Mapping[str, str]
    Key-value map 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.
    encryptionConfiguration Property Map
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name String
    The name of the activity to create.
    tags Map<String>
    Key-value map 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 Activity resource produces the following output properties:

    CreationDate string
    The date the activity was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    CreationDate string
    The date the activity was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate String
    The date the activity was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate string
    The date the activity was created.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creation_date str
    The date the activity was created.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate String
    The date the activity was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A 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 Activity Resource

    Get an existing Activity 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?: ActivityState, opts?: CustomResourceOptions): Activity
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_date: Optional[str] = None,
        encryption_configuration: Optional[ActivityEncryptionConfigurationArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Activity
    func GetActivity(ctx *Context, name string, id IDInput, state *ActivityState, opts ...ResourceOption) (*Activity, error)
    public static Activity Get(string name, Input<string> id, ActivityState? state, CustomResourceOptions? opts = null)
    public static Activity get(String name, Output<String> id, ActivityState 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:
    CreationDate string
    The date the activity was created.
    EncryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    Name string
    The name of the activity to create.
    Tags Dictionary<string, string>
    Key-value map 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    CreationDate string
    The date the activity was created.
    EncryptionConfiguration ActivityEncryptionConfigurationArgs
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    Name string
    The name of the activity to create.
    Tags map[string]string
    Key-value map 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
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate String
    The date the activity was created.
    encryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name String
    The name of the activity to create.
    tags Map<String,String>
    Key-value map 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate string
    The date the activity was created.
    encryptionConfiguration ActivityEncryptionConfiguration
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name string
    The name of the activity to create.
    tags {[key: string]: string}
    Key-value map 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}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creation_date str
    The date the activity was created.
    encryption_configuration ActivityEncryptionConfigurationArgs
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name str
    The name of the activity to create.
    tags Mapping[str, str]
    Key-value map 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]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    creationDate String
    The date the activity was created.
    encryptionConfiguration Property Map
    Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section Data at rest encyption in the AWS Step Functions User Guide.
    name String
    The name of the activity to create.
    tags Map<String>
    Key-value map 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ActivityEncryptionConfiguration, ActivityEncryptionConfigurationArgs

    KmsDataKeyReusePeriodSeconds int
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    KmsKeyId string
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    Type string
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY
    KmsDataKeyReusePeriodSeconds int
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    KmsKeyId string
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    Type string
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY
    kmsDataKeyReusePeriodSeconds Integer
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    kmsKeyId String
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    type String
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY
    kmsDataKeyReusePeriodSeconds number
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    kmsKeyId string
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    type string
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY
    kms_data_key_reuse_period_seconds int
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    kms_key_id str
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    type str
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY
    kmsDataKeyReusePeriodSeconds Number
    Maximum duration for which Activities will reuse data keys. When the period expires, Activities will call GenerateDataKey. This setting only applies to customer managed KMS key and does not apply to AWS owned KMS key.
    kmsKeyId String
    The alias, alias ARN, key ID, or key ARN of the symmetric encryption KMS key that encrypts the data key. To specify a KMS key in a different AWS account, the customer must use the key ARN or alias ARN. For more information regarding kms_key_id, see KeyId in the KMS documentation.
    type String
    The encryption option specified for the activity. Valid values: AWS_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY

    Import

    Using pulumi import, import activities using the arn. For example:

    $ pulumi import aws:sfn/activity:Activity foo arn:aws:states:eu-west-1:123456789098:activity:bar

    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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws