« blib/lib/Paws/CodeStar/CreateUserProfileResult.pm
↑ Summary
blib/lib/Paws/CodeStar/DeleteProjectResult.pm »
| 1 | |||
| 2 | package Paws::CodeStar::DeleteProject; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken' ); | ||
| 5 | has DeleteStack => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'deleteStack' ); | ||
| 6 | has Id => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'id' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteProject'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeStar::DeleteProjectResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CodeStar::DeleteProject - Arguments for method DeleteProject on L<Paws::CodeStar> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DeleteProject on the | ||
| 24 | L<AWS CodeStar|Paws::CodeStar> service. Use the attributes of this class | ||
| 25 | as arguments to method DeleteProject. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteProject. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $codestar = Paws->service('CodeStar'); | ||
| 32 | my $DeleteProjectResult = $codestar->DeleteProject( | ||
| 33 | Id => 'MyProjectId', | ||
| 34 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 35 | DeleteStack => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $ProjectArn = $DeleteProjectResult->ProjectArn; | ||
| 40 | my $StackId = $DeleteProjectResult->StackId; | ||
| 41 | |||
| 42 | # Returns a L<Paws::CodeStar::DeleteProjectResult> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codestar/DeleteProject> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ClientRequestToken => Str | ||
| 51 | |||
| 52 | A user- or system-generated token that identifies the entity that | ||
| 53 | requested project deletion. This token can be used to repeat the | ||
| 54 | request. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 DeleteStack => Bool | ||
| 59 | |||
| 60 | Whether to send a delete request for the primary stack in AWS | ||
| 61 | CloudFormation originally used to generate the project and its | ||
| 62 | resources. This option will delete all AWS resources for the project | ||
| 63 | (except for any buckets in Amazon S3) as well as deleting the project | ||
| 64 | itself. Recommended for most use cases. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Id => Str | ||
| 69 | |||
| 70 | The ID of the project to be deleted in AWS CodeStar. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method DeleteProject in L<Paws::CodeStar> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |