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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::ActivateTypeInput

Defined in:

gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_update ⇒ Boolean

  Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

• #execution_role_arn ⇒ String

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

• #logging_config ⇒ Types::LoggingConfig

  Contains logging configuration information for an extension.

• #major_version ⇒ Integer

  The major version of this extension you want to activate, if multiple major versions are available.

• #public_type_arn ⇒ String

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

• #publisher_id ⇒ String

  The ID of the extension publisher.

• #type ⇒ String

  The extension type.

• #type_name ⇒ String

  The name of the extension.

• #type_name_alias ⇒ String

  An alias to assign to the public extension, in this account and Region.

• #version_bump ⇒ String

  Manually updates a previously-activated type to a new major or minor version, if available.

Instance Attribute Details

#auto_update ⇒ Boolean

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_config ⇒ Types::LoggingConfig

Contains logging configuration information for an extension.

Returns:

• (Types::LoggingConfig)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_version ⇒ Integer

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_arn ⇒ String

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

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_id ⇒ String

The ID of the extension publisher.

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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 ⇒ String

The extension type.

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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 ⇒ String

The name of the extension.

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_alias ⇒ String

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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_bump ⇒ String

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 206

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