package Paws::CloudFormation::RegisterType; use Moose; has ClientRequestToken => (is => 'ro', isa => 'Str'); has ExecutionRoleArn => (is => 'ro', isa => 'Str'); has LoggingConfig => (is => 'ro', isa => 'Paws::CloudFormation::LoggingConfig'); has SchemaHandlerPackage => (is => 'ro', isa => 'Str', required => 1); has Type => (is => 'ro', isa => 'Str'); has TypeName => (is => 'ro', isa => 'Str', required => 1); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterType'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::RegisterTypeOutput'); class_has _result_key => (isa => 'Str', is => 'ro', default => 'RegisterTypeResult'); 1; ### main pod documentation begin ### =head1 NAME Paws::CloudFormation::RegisterType - Arguments for method RegisterType on L =head1 DESCRIPTION This class represents the parameters used for calling the method RegisterType on the L service. Use the attributes of this class as arguments to method RegisterType. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterType. =head1 SYNOPSIS my $cloudformation = Paws->service('CloudFormation'); my $RegisterTypeOutput = $cloudformation->RegisterType( SchemaHandlerPackage => 'MyS3Url', TypeName => 'MyTypeName', ClientRequestToken => 'MyRequestToken', # OPTIONAL ExecutionRoleArn => 'MyRoleArn', # OPTIONAL LoggingConfig => { LogGroupName => 'MyLogGroupName', # min: 1, max: 512 LogRoleArn => 'MyRoleArn', # min: 1, max: 256 }, # OPTIONAL Type => 'RESOURCE', # OPTIONAL ); # Results: my $RegistrationToken = $RegisterTypeOutput->RegistrationToken; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 ClientRequestToken => Str 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. =head2 ExecutionRoleArn => Str 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 (C). For more information on adding trust relationships, see Modifying a role trust policy in the I. If your extension calls AWS APIs in any of its handlers, you must create an I< IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) > that includes the necessary permissions to call those AWS 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. =head2 LoggingConfig => L Specifies logging configuration information for an extension. =head2 B SchemaHandlerPackage => Str 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 (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the I. The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the I. =head2 Type => Str The kind of extension. Valid values are: C<"RESOURCE">, C<"MODULE"> =head2 B TypeName => Str The name of the extension being registered. We recommend that extension names adhere to the following patterns: =over =item * For resource types, I::I::I. =item * For modules, I::I::I::MODULE. =back The following organization namespaces are reserved and cannot be used in your extension names: =over =item * C =item * C =item * C =item * C =item * C =item * C =back =head1 SEE ALSO This class forms part of L, documenting arguments for method RegisterType in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut