blib/lib/Paws/SageMaker/CreateDomain.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateDomain;
3 use Moose;
4 has AppNetworkAccessType => (is => 'ro', isa => 'Str');
5 has AuthMode => (is => 'ro', isa => 'Str', required => 1);
6 has DefaultUserSettings => (is => 'ro', isa => 'Paws::SageMaker::UserSettings', required => 1);
7 has DomainName => (is => 'ro', isa => 'Str', required => 1);
8 has HomeEfsFileSystemKmsKeyId => (is => 'ro', isa => 'Str');
9 has KmsKeyId => (is => 'ro', isa => 'Str');
10 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
11 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
12 has VpcId => (is => 'ro', isa => 'Str', required => 1);
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDomain');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateDomainResponse');
18 class_has _result_key => (isa => 'Str', is => 'ro');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::SageMaker::CreateDomain - Arguments for method CreateDomain on L<Paws::SageMaker>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreateDomain on the
30 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
31 as arguments to method CreateDomain.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDomain.
34  
35 =head1 SYNOPSIS
36  
37 my $api.sagemaker = Paws->service('SageMaker');
38 my $CreateDomainResponse = $api . sagemaker->CreateDomain(
39 AuthMode => 'SSO',
40 DefaultUserSettings => {
41 ExecutionRole => 'MyRoleArn', # min: 20, max: 2048; OPTIONAL
42 JupyterServerAppSettings => {
43 DefaultResourceSpec => {
44 InstanceType => 'system'
45 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
46 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
47 SageMakerImageVersionArn =>
48 'MyImageVersionArn', # max: 256; OPTIONAL
49 }, # OPTIONAL
50 }, # OPTIONAL
51 KernelGatewayAppSettings => {
52 CustomImages => [
53 {
54 AppImageConfigName => 'MyAppImageConfigName', # max: 63
55 ImageName => 'MyImageName', # min: 1, max: 63
56 ImageVersionNumber => 1, # OPTIONAL
57 },
58 ...
59 ], # max: 30; OPTIONAL
60 DefaultResourceSpec => {
61 InstanceType => 'system'
62 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
63 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
64 SageMakerImageVersionArn =>
65 'MyImageVersionArn', # max: 256; OPTIONAL
66 }, # OPTIONAL
67 }, # OPTIONAL
68 SecurityGroups => [
69 'MySecurityGroupId', ... # max: 32
70 ], # max: 5; OPTIONAL
71 SharingSettings => {
72 NotebookOutputOption =>
73 'Allowed', # values: Allowed, Disabled; OPTIONAL
74 S3KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
75 S3OutputPath => 'MyS3Uri', # max: 1024; OPTIONAL
76 }, # OPTIONAL
77 TensorBoardAppSettings => {
78 DefaultResourceSpec => {
79 InstanceType => 'system'
80 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
81 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
82 SageMakerImageVersionArn =>
83 'MyImageVersionArn', # max: 256; OPTIONAL
84 }, # OPTIONAL
85 }, # OPTIONAL
86 },
87 DomainName => 'MyDomainName',
88 SubnetIds => [
89 'MySubnetId', ... # max: 32
90 ],
91 VpcId => 'MyVpcId',
92 AppNetworkAccessType => 'PublicInternetOnly', # OPTIONAL
93 HomeEfsFileSystemKmsKeyId => 'MyKmsKeyId', # OPTIONAL
94 KmsKeyId => 'MyKmsKeyId', # OPTIONAL
95 Tags => [
96 {
97 Key => 'MyTagKey', # min: 1, max: 128
98 Value => 'MyTagValue', # max: 256
99  
100 },
101 ...
102 ], # OPTIONAL
103 );
104  
105 # Results:
106 my $DomainArn = $CreateDomainResponse->DomainArn;
107 my $Url = $CreateDomainResponse->Url;
108  
109 # Returns a L<Paws::SageMaker::CreateDomainResponse> object.
110  
111 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.
112 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateDomain>
113  
114 =head1 ATTRIBUTES
115  
116  
117 =head2 AppNetworkAccessType => Str
118  
119 Specifies the VPC used for non-EFS traffic. The default value is
120 C<PublicInternetOnly>.
121  
122 =over
123  
124 =item *
125  
126 C<PublicInternetOnly> - Non-EFS traffic is through a VPC managed by
127 Amazon SageMaker, which allows direct internet access
128  
129 =item *
130  
131 C<VpcOnly> - All Studio traffic is through the specified VPC and
132 subnets
133  
134 =back
135  
136  
137 Valid values are: C<"PublicInternetOnly">, C<"VpcOnly">
138  
139 =head2 B<REQUIRED> AuthMode => Str
140  
141 The mode of authentication that members use to access the domain.
142  
143 Valid values are: C<"SSO">, C<"IAM">
144  
145 =head2 B<REQUIRED> DefaultUserSettings => L<Paws::SageMaker::UserSettings>
146  
147 The default settings to use to create a user profile when
148 C<UserSettings> isn't specified in the call to the C<CreateUserProfile>
149 API.
150  
151 C<SecurityGroups> is aggregated when specified in both calls. For all
152 other settings in C<UserSettings>, the values specified in
153 C<CreateUserProfile> take precedence over those specified in
154 C<CreateDomain>.
155  
156  
157  
158 =head2 B<REQUIRED> DomainName => Str
159  
160 A name for the domain.
161  
162  
163  
164 =head2 HomeEfsFileSystemKmsKeyId => Str
165  
166 This member is deprecated and replaced with C<KmsKeyId>.
167  
168  
169  
170 =head2 KmsKeyId => Str
171  
172 SageMaker uses Amazon Web Services KMS to encrypt the EFS volume
173 attached to the domain with an Amazon Web Services managed customer
174 master key (CMK) by default. For more control, specify a customer
175 managed CMK.
176  
177  
178  
179 =head2 B<REQUIRED> SubnetIds => ArrayRef[Str|Undef]
180  
181 The VPC subnets that Studio uses for communication.
182  
183  
184  
185 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
186  
187 Tags to associated with the Domain. Each tag consists of a key and an
188 optional value. Tag keys must be unique per resource. Tags are
189 searchable using the C<Search> API.
190  
191 Tags that you specify for the Domain are also added to all Apps that
192 the Domain launches.
193  
194  
195  
196 =head2 B<REQUIRED> VpcId => Str
197  
198 The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for
199 communication.
200  
201  
202  
203  
204 =head1 SEE ALSO
205  
206 This class forms part of L<Paws>, documenting arguments for method CreateDomain in L<Paws::SageMaker>
207  
208 =head1 BUGS and CONTRIBUTIONS
209  
210 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
211  
212 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
213  
214 =cut
215