Class: AWSCDK::StepFunctions::CfnActivityProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/cfn_activity_props.rb

Overview

Properties for defining a CfnActivity.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, encryption_configuration: nil, tags: nil) ⇒ CfnActivityProps

Returns a new instance of CfnActivityProps.

Parameters:



12
13
14
15
16
17
18
19
 
# File 'step_functions/cfn_activity_props.rb', line 12

def initialize(name:, encryption_configuration: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @encryption_configuration = encryption_configuration.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnActivity::EncryptionConfigurationProperty.new(**encryption_configuration.transform_keys(&:to_sym)) : encryption_configuration
  Jsii::Type.check_type(@encryption_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmbkFjdGl2aXR5LkVuY3J5cHRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "encryptionConfiguration") unless @encryption_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnActivity::TagsEntryProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmbkFjdGl2aXR5LlRhZ3NFbnRyeVByb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#encryption_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Encryption configuration for the activity.

Activity configuration is immutable, and resource names must be unique. To set customer managed keys for encryption, you must create a new Activity . If you attempt to change the configuration in your CFN template for an existing activity, you will receive an ActivityAlreadyExists exception.

To update your activity to include customer managed keys, set a new activity name within your CloudFormation template.

Returns:

See Also:



46
47
48
 
# File 'step_functions/cfn_activity_props.rb', line 46

def encryption_configuration
  @encryption_configuration
end

#name ⇒ String (readonly)

The name of the activity.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ $ & , ; : /`
  • control characters ( U+0000-001F , U+007F-009F , U+FFFE-FFFF )
  • surrogates ( U+D800-DFFF )
  • invalid characters ( U+10FFFF )

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'step_functions/cfn_activity_props.rb', line 37

def name
  @name
end

#tags ⇒ Array<AWSCDK::StepFunctions::CfnActivity::TagsEntryProperty>? (readonly)

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

Returns:

See Also:



53
54
55
 
# File 'step_functions/cfn_activity_props.rb', line 53

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
 
# File 'step_functions/cfn_activity_props.rb', line 55

def self.jsii_properties
  {
    :name => "name",
    :encryption_configuration => "encryptionConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'step_functions/cfn_activity_props.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "encryptionConfiguration" => @encryption_configuration,
    "tags" => @tags,
  })
  result.compact
end