github.com/openshift-online/ocm-sdk-go@v0.1.473/clustersmgmt/v1/cluster_type_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 v1 // github.com/openshift-online/ocm-sdk-go/clustersmgmt/v1
    21  
    22  import (
    23  	api_v1 "github.com/openshift-online/ocm-api-model/clientapi/clustersmgmt/v1"
    24  )
    25  
    26  // ClusterKind is the name of the type used to represent objects
    27  // of type 'cluster'.
    28  const ClusterKind = api_v1.ClusterKind
    29  
    30  // ClusterLinkKind is the name of the type used to represent links
    31  // to objects of type 'cluster'.
    32  const ClusterLinkKind = api_v1.ClusterLinkKind
    33  
    34  // ClusterNilKind is the name of the type used to nil references
    35  // to objects of type 'cluster'.
    36  const ClusterNilKind = api_v1.ClusterNilKind
    37  
    38  // Cluster represents the values of the 'cluster' type.
    39  //
    40  // Definition of an _OpenShift_ cluster.
    41  //
    42  // The `cloud_provider` attribute is a reference to the cloud provider. When a
    43  // cluster is retrieved it will be a link to the cloud provider, containing only
    44  // the kind, id and href attributes:
    45  //
    46  // ```json
    47  //
    48  //	{
    49  //	  "cloud_provider": {
    50  //	    "kind": "CloudProviderLink",
    51  //	    "id": "123",
    52  //	    "href": "/api/clusters_mgmt/v1/cloud_providers/123"
    53  //	  }
    54  //	}
    55  //
    56  // ```
    57  //
    58  // When a cluster is created this is optional, and if used it should contain the
    59  // identifier of the cloud provider to use:
    60  //
    61  // ```json
    62  //
    63  //	{
    64  //	  "cloud_provider": {
    65  //	    "id": "123",
    66  //	  }
    67  //	}
    68  //
    69  // ```
    70  //
    71  // If not included, then the cluster will be created using the default cloud
    72  // provider, which is currently Amazon Web Services.
    73  //
    74  // The region attribute is mandatory when a cluster is created.
    75  //
    76  // The `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain`
    77  // attributes are mandatory when creation a cluster with your own Amazon Web
    78  // Services account.
    79  type Cluster = api_v1.Cluster
    80  
    81  // ClusterListKind is the name of the type used to represent list of objects of
    82  // type 'cluster'.
    83  const ClusterListKind = api_v1.ClusterListKind
    84  
    85  // ClusterListLinkKind is the name of the type used to represent links to list
    86  // of objects of type 'cluster'.
    87  const ClusterListLinkKind = api_v1.ClusterListLinkKind
    88  
    89  // ClusterNilKind is the name of the type used to nil lists of objects of
    90  // type 'cluster'.
    91  const ClusterListNilKind = api_v1.ClusterListNilKind
    92  
    93  type ClusterList = api_v1.ClusterList