« blib/lib/Paws/Amplify/UpdateBranchResult.pm
↑ Summary
blib/lib/Paws/Amplify/UpdateDomainAssociationResult.pm »
| 1 | |||
| 2 | package Paws::Amplify::UpdateDomainAssociation; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has AutoSubDomainCreationPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'autoSubDomainCreationPatterns'); | ||
| 6 | has AutoSubDomainIAMRole => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'autoSubDomainIAMRole'); | ||
| 7 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'domainName', required => 1); | ||
| 8 | has EnableAutoSubDomain => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableAutoSubDomain'); | ||
| 9 | has SubDomainSettings => (is => 'ro', isa => 'ArrayRef[Paws::Amplify::SubDomainSetting]', traits => ['NameInRequest'], request_name => 'subDomainSettings', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDomainAssociation'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apps/{appId}/domains/{domainName}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Amplify::UpdateDomainAssociationResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Amplify::UpdateDomainAssociation - Arguments for method UpdateDomainAssociation on L<Paws::Amplify> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method UpdateDomainAssociation on the | ||
| 28 | L<AWS Amplify|Paws::Amplify> service. Use the attributes of this class | ||
| 29 | as arguments to method UpdateDomainAssociation. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDomainAssociation. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $amplify = Paws->service('Amplify'); | ||
| 36 | my $UpdateDomainAssociationResult = $amplify->UpdateDomainAssociation( | ||
| 37 | AppId => 'MyAppId', | ||
| 38 | DomainName => 'MyDomainName', | ||
| 39 | SubDomainSettings => [ | ||
| 40 | { | ||
| 41 | BranchName => 'MyBranchName', # min: 1, max: 255 | ||
| 42 | Prefix => 'MyDomainPrefix', # max: 255 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | AutoSubDomainCreationPatterns => [ | ||
| 48 | 'MyAutoSubDomainCreationPattern', | ||
| 49 | ... # min: 1, max: 2048 | ||
| 50 | ], # OPTIONAL | ||
| 51 | AutoSubDomainIAMRole => 'MyAutoSubDomainIAMRole', # OPTIONAL | ||
| 52 | EnableAutoSubDomain => 1, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $DomainAssociation = $UpdateDomainAssociationResult->DomainAssociation; | ||
| 57 | |||
| 58 | # Returns a L<Paws::Amplify::UpdateDomainAssociationResult> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplify/UpdateDomainAssociation> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> AppId => Str | ||
| 67 | |||
| 68 | The unique ID for an Amplify app. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 AutoSubDomainCreationPatterns => ArrayRef[Str|Undef] | ||
| 73 | |||
| 74 | Sets the branch patterns for automatic subdomain creation. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 AutoSubDomainIAMRole => Str | ||
| 79 | |||
| 80 | The required AWS Identity and Access Management (IAM) service role for | ||
| 81 | the Amazon Resource Name (ARN) for automatically creating subdomains. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> DomainName => Str | ||
| 86 | |||
| 87 | The name of the domain. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 EnableAutoSubDomain => Bool | ||
| 92 | |||
| 93 | Enables the automated creation of subdomains for branches. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> SubDomainSettings => ArrayRef[L<Paws::Amplify::SubDomainSetting>] | ||
| 98 | |||
| 99 | Describes the settings for the subdomain. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, documenting arguments for method UpdateDomainAssociation in L<Paws::Amplify> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |