AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::RegisterTypeRequest Class Reference

#include <RegisterTypeRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::RegisterTypeRequest:

Public Member Functions

 RegisterTypeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const RegistryTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const RegistryType &value)
 
void SetType (RegistryType &&value)
 
RegisterTypeRequestWithType (const RegistryType &value)
 
RegisterTypeRequestWithType (RegistryType &&value)
 
const Aws::StringGetTypeName () const
 
bool TypeNameHasBeenSet () const
 
void SetTypeName (const Aws::String &value)
 
void SetTypeName (Aws::String &&value)
 
void SetTypeName (const char *value)
 
RegisterTypeRequestWithTypeName (const Aws::String &value)
 
RegisterTypeRequestWithTypeName (Aws::String &&value)
 
RegisterTypeRequestWithTypeName (const char *value)
 
const Aws::StringGetSchemaHandlerPackage () const
 
bool SchemaHandlerPackageHasBeenSet () const
 
void SetSchemaHandlerPackage (const Aws::String &value)
 
void SetSchemaHandlerPackage (Aws::String &&value)
 
void SetSchemaHandlerPackage (const char *value)
 
RegisterTypeRequestWithSchemaHandlerPackage (const Aws::String &value)
 
RegisterTypeRequestWithSchemaHandlerPackage (Aws::String &&value)
 
RegisterTypeRequestWithSchemaHandlerPackage (const char *value)
 
const LoggingConfigGetLoggingConfig () const
 
bool LoggingConfigHasBeenSet () const
 
void SetLoggingConfig (const LoggingConfig &value)
 
void SetLoggingConfig (LoggingConfig &&value)
 
RegisterTypeRequestWithLoggingConfig (const LoggingConfig &value)
 
RegisterTypeRequestWithLoggingConfig (LoggingConfig &&value)
 
const Aws::StringGetExecutionRoleArn () const
 
bool ExecutionRoleArnHasBeenSet () const
 
void SetExecutionRoleArn (const Aws::String &value)
 
void SetExecutionRoleArn (Aws::String &&value)
 
void SetExecutionRoleArn (const char *value)
 
RegisterTypeRequestWithExecutionRoleArn (const Aws::String &value)
 
RegisterTypeRequestWithExecutionRoleArn (Aws::String &&value)
 
RegisterTypeRequestWithExecutionRoleArn (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
RegisterTypeRequestWithClientRequestToken (const Aws::String &value)
 
RegisterTypeRequestWithClientRequestToken (Aws::String &&value)
 
RegisterTypeRequestWithClientRequestToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file RegisterTypeRequest.h.

Constructor & Destructor Documentation

◆ RegisterTypeRequest()

Aws::CloudFormation::Model::RegisterTypeRequest::RegisterTypeRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::ClientRequestTokenHasBeenSet ( ) const
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 536 of file RegisterTypeRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::RegisterTypeRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExecutionRoleArnHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::ExecutionRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 393 of file RegisterTypeRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::CloudFormation::Model::RegisterTypeRequest::GetClientRequestToken ( ) const
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 528 of file RegisterTypeRequest.h.

◆ GetExecutionRoleArn()

const Aws::String& Aws::CloudFormation::Model::RegisterTypeRequest::GetExecutionRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 372 of file RegisterTypeRequest.h.

◆ GetLoggingConfig()

const LoggingConfig& Aws::CloudFormation::Model::RegisterTypeRequest::GetLoggingConfig ( ) const
inline

Specifies logging configuration information for an extension.

Definition at line 325 of file RegisterTypeRequest.h.

◆ GetSchemaHandlerPackage()

const Aws::String& Aws::CloudFormation::Model::RegisterTypeRequest::GetSchemaHandlerPackage ( ) const
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 200 of file RegisterTypeRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::RegisterTypeRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file RegisterTypeRequest.h.

◆ GetType()

const RegistryType& Aws::CloudFormation::Model::RegisterTypeRequest::GetType ( ) const
inline

The kind of extension.

Definition at line 44 of file RegisterTypeRequest.h.

◆ GetTypeName()

const Aws::String& Aws::CloudFormation::Model::RegisterTypeRequest::GetTypeName ( ) const
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 84 of file RegisterTypeRequest.h.

◆ LoggingConfigHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::LoggingConfigHasBeenSet ( ) const
inline

Specifies logging configuration information for an extension.

Definition at line 330 of file RegisterTypeRequest.h.

◆ SchemaHandlerPackageHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::SchemaHandlerPackageHasBeenSet ( ) const
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 217 of file RegisterTypeRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::RegisterTypeRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetClientRequestToken ( Aws::String &&  value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 552 of file RegisterTypeRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetClientRequestToken ( const Aws::String value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 544 of file RegisterTypeRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetClientRequestToken ( const char *  value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 560 of file RegisterTypeRequest.h.

◆ SetExecutionRoleArn() [1/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetExecutionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 435 of file RegisterTypeRequest.h.

◆ SetExecutionRoleArn() [2/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetExecutionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 414 of file RegisterTypeRequest.h.

◆ SetExecutionRoleArn() [3/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetExecutionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 456 of file RegisterTypeRequest.h.

◆ SetLoggingConfig() [1/2]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetLoggingConfig ( const LoggingConfig value)
inline

Specifies logging configuration information for an extension.

Definition at line 335 of file RegisterTypeRequest.h.

◆ SetLoggingConfig() [2/2]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetLoggingConfig ( LoggingConfig &&  value)
inline

Specifies logging configuration information for an extension.

Definition at line 340 of file RegisterTypeRequest.h.

◆ SetSchemaHandlerPackage() [1/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetSchemaHandlerPackage ( Aws::String &&  value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 251 of file RegisterTypeRequest.h.

◆ SetSchemaHandlerPackage() [2/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetSchemaHandlerPackage ( const Aws::String value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 234 of file RegisterTypeRequest.h.

◆ SetSchemaHandlerPackage() [3/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetSchemaHandlerPackage ( const char *  value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 268 of file RegisterTypeRequest.h.

◆ SetType() [1/2]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetType ( const RegistryType value)
inline

The kind of extension.

Definition at line 54 of file RegisterTypeRequest.h.

◆ SetType() [2/2]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetType ( RegistryType &&  value)
inline

The kind of extension.

Definition at line 59 of file RegisterTypeRequest.h.

◆ SetTypeName() [1/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetTypeName ( Aws::String &&  value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 126 of file RegisterTypeRequest.h.

◆ SetTypeName() [2/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetTypeName ( const Aws::String value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 112 of file RegisterTypeRequest.h.

◆ SetTypeName() [3/3]

void Aws::CloudFormation::Model::RegisterTypeRequest::SetTypeName ( const char *  value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 140 of file RegisterTypeRequest.h.

◆ TypeHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::TypeHasBeenSet ( ) const
inline

The kind of extension.

Definition at line 49 of file RegisterTypeRequest.h.

◆ TypeNameHasBeenSet()

bool Aws::CloudFormation::Model::RegisterTypeRequest::TypeNameHasBeenSet ( ) const
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 98 of file RegisterTypeRequest.h.

◆ WithClientRequestToken() [1/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithClientRequestToken ( Aws::String &&  value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 576 of file RegisterTypeRequest.h.

◆ WithClientRequestToken() [2/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithClientRequestToken ( const Aws::String value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 568 of file RegisterTypeRequest.h.

◆ WithClientRequestToken() [3/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithClientRequestToken ( const char *  value)
inline

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Definition at line 584 of file RegisterTypeRequest.h.

◆ WithExecutionRoleArn() [1/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithExecutionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 498 of file RegisterTypeRequest.h.

◆ WithExecutionRoleArn() [2/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithExecutionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 477 of file RegisterTypeRequest.h.

◆ WithExecutionRoleArn() [3/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithExecutionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Definition at line 519 of file RegisterTypeRequest.h.

◆ WithLoggingConfig() [1/2]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithLoggingConfig ( const LoggingConfig value)
inline

Specifies logging configuration information for an extension.

Definition at line 345 of file RegisterTypeRequest.h.

◆ WithLoggingConfig() [2/2]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithLoggingConfig ( LoggingConfig &&  value)
inline

Specifies logging configuration information for an extension.

Definition at line 350 of file RegisterTypeRequest.h.

◆ WithSchemaHandlerPackage() [1/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithSchemaHandlerPackage ( Aws::String &&  value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 302 of file RegisterTypeRequest.h.

◆ WithSchemaHandlerPackage() [2/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithSchemaHandlerPackage ( const Aws::String value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 285 of file RegisterTypeRequest.h.

◆ WithSchemaHandlerPackage() [3/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithSchemaHandlerPackage ( const char *  value)
inline

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Definition at line 319 of file RegisterTypeRequest.h.

◆ WithType() [1/2]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithType ( const RegistryType value)
inline

The kind of extension.

Definition at line 64 of file RegisterTypeRequest.h.

◆ WithType() [2/2]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithType ( RegistryType &&  value)
inline

The kind of extension.

Definition at line 69 of file RegisterTypeRequest.h.

◆ WithTypeName() [1/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithTypeName ( Aws::String &&  value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 168 of file RegisterTypeRequest.h.

◆ WithTypeName() [2/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithTypeName ( const Aws::String value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 154 of file RegisterTypeRequest.h.

◆ WithTypeName() [3/3]

RegisterTypeRequest& Aws::CloudFormation::Model::RegisterTypeRequest::WithTypeName ( const char *  value)
inline

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Definition at line 182 of file RegisterTypeRequest.h.


The documentation for this class was generated from the following file: