« blib/lib/Paws/CodeStarConnections/CreateConnectionOutput.pm
↑ Summary
blib/lib/Paws/CodeStarConnections/CreateHostOutput.pm »
| 1 | |||
| 2 | package Paws::CodeStarConnections::CreateHost; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ProviderEndpoint => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ProviderType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CodeStarConnections::Tag]'); | ||
| 8 | has VpcConfiguration => (is => 'ro', isa => 'Paws::CodeStarConnections::VpcConfiguration'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateHost'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeStarConnections::CreateHostOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CodeStarConnections::CreateHost - Arguments for method CreateHost on L<Paws::CodeStarConnections> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateHost on the | ||
| 26 | L<AWS CodeStar connections|Paws::CodeStarConnections> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateHost. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateHost. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $codestar-connections = Paws->service('CodeStarConnections'); | ||
| 34 | my $CreateHostOutput = $codestar -connections->CreateHost( | ||
| 35 | Name => 'MyHostName', | ||
| 36 | ProviderEndpoint => 'MyUrl', | ||
| 37 | ProviderType => 'Bitbucket', | ||
| 38 | Tags => [ | ||
| 39 | { | ||
| 40 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 41 | Value => 'MyTagValue', # max: 256 | ||
| 42 | |||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | VpcConfiguration => { | ||
| 47 | SecurityGroupIds => [ | ||
| 48 | 'MySecurityGroupId', ... # min: 11, max: 20 | ||
| 49 | ], # min: 1, max: 10 | ||
| 50 | SubnetIds => [ | ||
| 51 | 'MySubnetId', ... # min: 15, max: 24 | ||
| 52 | ], # min: 1, max: 10 | ||
| 53 | VpcId => 'MyVpcId', # min: 12, max: 21 | ||
| 54 | TlsCertificate => 'MyTlsCertificate', # min: 1, max: 16384; OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $HostArn = $CreateHostOutput->HostArn; | ||
| 60 | my $Tags = $CreateHostOutput->Tags; | ||
| 61 | |||
| 62 | # Returns a L<Paws::CodeStarConnections::CreateHostOutput> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codestar-connections/CreateHost> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Name => Str | ||
| 71 | |||
| 72 | The name of the host to be created. The name must be unique in the | ||
| 73 | calling AWS account. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> ProviderEndpoint => Str | ||
| 78 | |||
| 79 | The endpoint of the infrastructure to be represented by the host after | ||
| 80 | it is created. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> ProviderType => Str | ||
| 85 | |||
| 86 | The name of the installed provider to be associated with your | ||
| 87 | connection. The host resource represents the infrastructure where your | ||
| 88 | provider type is installed. The valid provider type is GitHub | ||
| 89 | Enterprise Server. | ||
| 90 | |||
| 91 | Valid values are: C<"Bitbucket">, C<"GitHub">, C<"GitHubEnterpriseServer"> | ||
| 92 | |||
| 93 | =head2 Tags => ArrayRef[L<Paws::CodeStarConnections::Tag>] | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 VpcConfiguration => L<Paws::CodeStarConnections::VpcConfiguration> | ||
| 100 | |||
| 101 | The VPC configuration to be provisioned for the host. A VPC must be | ||
| 102 | configured and the infrastructure to be represented by the host must | ||
| 103 | already be connected to the VPC. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method CreateHost in L<Paws::CodeStarConnections> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |