github.com/openshift-online/ocm-sdk-go@v0.1.473/arohcp/v1alpha1/cluster_builder_alias.go (about)

     1  /*
     2  Copyright (c) 2020 Red Hat, Inc.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8    http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
    18  // your changes will be lost when the file is generated again.
    19  
    20  package v1alpha1 // github.com/openshift-online/ocm-sdk-go/arohcp/v1alpha1
    21  
    22  import (
    23  	api_v1alpha1 "github.com/openshift-online/ocm-api-model/clientapi/arohcp/v1alpha1"
    24  )
    25  
    26  // ClusterBuilder contains the data and logic needed to build 'cluster' objects.
    27  //
    28  // Definition of an _OpenShift_ cluster.
    29  //
    30  // The `cloud_provider` attribute is a reference to the cloud provider. When a
    31  // cluster is retrieved it will be a link to the cloud provider, containing only
    32  // the kind, id and href attributes:
    33  //
    34  // ```json
    35  //
    36  //	{
    37  //	  "cloud_provider": {
    38  //	    "kind": "CloudProviderLink",
    39  //	    "id": "123",
    40  //	    "href": "/api/clusters_mgmt/v1/cloud_providers/123"
    41  //	  }
    42  //	}
    43  //
    44  // ```
    45  //
    46  // When a cluster is created this is optional, and if used it should contain the
    47  // identifier of the cloud provider to use:
    48  //
    49  // ```json
    50  //
    51  //	{
    52  //	  "cloud_provider": {
    53  //	    "id": "123",
    54  //	  }
    55  //	}
    56  //
    57  // ```
    58  //
    59  // If not included, then the cluster will be created using the default cloud
    60  // provider, which is currently Amazon Web Services.
    61  //
    62  // The region attribute is mandatory when a cluster is created.
    63  //
    64  // The `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain`
    65  // attributes are mandatory when creation a cluster with your own Amazon Web
    66  // Services account.
    67  type ClusterBuilder = api_v1alpha1.ClusterBuilder
    68  
    69  // NewCluster creates a new builder of 'cluster' objects.
    70  var NewCluster = api_v1alpha1.NewCluster