Class: Aws::ServerlessApplicationRepository::Types::CreateCloudFormationChangeSetInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-serverlessapplicationrepository/types.rb

Overview

Create an application change set request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilities ⇒ Array<String>

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: [AWS::IAM::Group], [AWS::IAM::InstanceProfile], [AWS::IAM::Policy], and [AWS::IAM::Role]. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: [AWS::Lambda::Permission], [AWS::IAM:Policy], [AWS::ApplicationAutoScaling::ScalingPolicy], [AWS::S3::BucketPolicy], [AWS::SQS::QueuePolicy], and [AWS::SNS:TopicPolicy].

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don’t specify this parameter for an application that requires capabilities, the call will fail.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html [3]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html [4]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html [5]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html [6]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html [7]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html [8]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html [9]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html

Returns:

  • (Array<String>) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_name ⇒ String

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arns ⇒ Array<String>

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (Array<String>) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_overrides ⇒ Array<Types::ParameterValue>

A list of parameter values for the parameters of the application.

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types ⇒ Array<String>

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (Array<String>) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_configuration ⇒ Types::RollbackConfiguration

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

The semantic version of the application:

semver.org/][1

[1]: semver.org/

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ String

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href=“docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet”>CreateChangeSet</a>

</i> API.

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_id ⇒ String

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]8\-[0-9a-fA-F]4\-[0-9a-fA-F]4\-[0-9a-fA-F]4\-[0-9a-fA-F]12

Returns:

  • (String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 896

class CreateCloudFormationChangeSetInput < Struct.new(
  :capabilities,
  :change_set_name,
  :client_token,
  :description,
  :notification_arns,
  :parameter_overrides,
  :resource_types,
  :rollback_configuration,
  :semantic_version,
  :stack_name,
  :tags,
  :template_id)
  SENSITIVE = []
  include Aws::Structure
end