« blib/lib/Paws/Firehose/DataFormatConversionConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/DeleteDeliveryStreamOutput.pm »
| 1 | |||
| 2 | package Paws::Firehose::DeleteDeliveryStream; | ||
| 3 | use Moose; | ||
| 4 | has AllowForceDelete => (is => 'ro', isa => 'Bool'); | ||
| 5 | has DeliveryStreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteDeliveryStream'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Firehose::DeleteDeliveryStreamOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Firehose::DeleteDeliveryStream - Arguments for method DeleteDeliveryStream on L<Paws::Firehose> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DeleteDeliveryStream on the | ||
| 23 | L<Amazon Kinesis Firehose|Paws::Firehose> service. Use the attributes of this class | ||
| 24 | as arguments to method DeleteDeliveryStream. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteDeliveryStream. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $firehose = Paws->service('Firehose'); | ||
| 31 | my $DeleteDeliveryStreamOutput = $firehose->DeleteDeliveryStream( | ||
| 32 | DeliveryStreamName => 'MyDeliveryStreamName', | ||
| 33 | AllowForceDelete => 1, # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | 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. | ||
| 37 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/firehose/DeleteDeliveryStream> | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 AllowForceDelete => Bool | ||
| 43 | |||
| 44 | Set this to true if you want to delete the delivery stream even if | ||
| 45 | Kinesis Data Firehose is unable to retire the grant for the CMK. | ||
| 46 | Kinesis Data Firehose might be unable to retire the grant due to a | ||
| 47 | customer error, such as when the CMK or the grant are in an invalid | ||
| 48 | state. If you force deletion, you can then use the RevokeGrant | ||
| 49 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) | ||
| 50 | operation to revoke the grant you gave to Kinesis Data Firehose. If a | ||
| 51 | failure to retire the grant happens due to an AWS KMS issue, Kinesis | ||
| 52 | Data Firehose keeps retrying the delete operation. | ||
| 53 | |||
| 54 | The default value is false. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> DeliveryStreamName => Str | ||
| 59 | |||
| 60 | The name of the delivery stream. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, documenting arguments for method DeleteDeliveryStream in L<Paws::Firehose> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |