Class: Aws::CloudFormation::Types::ActivateTypeInput

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

Overview

Note:

When making an API call, you may pass ActivateTypeInput data as a hash:

{
  type: "RESOURCE", # accepts RESOURCE, MODULE
  public_type_arn: "ThirdPartyTypeArn",
  publisher_id: "PublisherId",
  type_name: "TypeName",
  type_name_alias: "TypeName",
  auto_update: false,
  logging_config: {
    log_role_arn: "RoleArn", # required
    log_group_name: "LogGroupName", # required
  },
  execution_role_arn: "RoleArn",
  version_bump: "MAJOR", # accepts MAJOR, MINOR
  major_version: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_updateBoolean

Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is `true`.

Returns:

  • (Boolean)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

The name of the IAM execution role to use to activate the extension.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configTypes::LoggingConfig

Contains logging configuration information for an extension.


215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#major_versionInteger

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify `MajorVersion` or `VersionBump`, but not both.

Returns:

  • (Integer)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#public_type_arnString

The Amazon Resource Number (ARN) of the public extension.

Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#publisher_idString

The ID of the extension publisher.

Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The extension type.

Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

The name of the extension.

Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#type_name_aliasString

An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end

#version_bumpString

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of `AutoUpdate`.

  • `MAJOR`: CloudFormation updates the extension to the newest major version, if one is available.

  • `MINOR`: CloudFormation updates the extension to the newest minor version, if one is available.

Returns:

  • (String)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/aws-sdk-cloudformation/types.rb', line 215

class ActivateTypeInput < Struct.new(
  :type,
  :public_type_arn,
  :publisher_id,
  :type_name,
  :type_name_alias,
  :auto_update,
  :logging_config,
  :execution_role_arn,
  :version_bump,
  :major_version)
  SENSITIVE = []
  include Aws::Structure
end