sigs.k8s.io/cluster-api-provider-aws@v1.5.5/pkg/cloud/scope/sg.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     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  package scope
    18  
    19  import (
    20  	infrav1 "sigs.k8s.io/cluster-api-provider-aws/api/v1beta1"
    21  	"sigs.k8s.io/cluster-api-provider-aws/pkg/cloud"
    22  )
    23  
    24  // SGScope is the interface for the scope to be used with the sg service.
    25  type SGScope interface {
    26  	cloud.ClusterScoper
    27  
    28  	// Network returns the cluster network object.
    29  	Network() *infrav1.NetworkStatus
    30  
    31  	// SecurityGroups returns the cluster security groups as a map, it creates the map if empty.
    32  	SecurityGroups() map[infrav1.SecurityGroupRole]infrav1.SecurityGroup
    33  
    34  	// SecurityGroupOverrides returns the security groups that are overridden in the cluster spec
    35  	SecurityGroupOverrides() map[infrav1.SecurityGroupRole]string
    36  
    37  	// VPC returns the cluster VPC.
    38  	VPC() *infrav1.VPCSpec
    39  
    40  	// CNIIngressRules returns the CNI spec ingress rules.
    41  	CNIIngressRules() infrav1.CNIIngressRules
    42  
    43  	// Bastion returns the bastion details for the cluster.
    44  	Bastion() *infrav1.Bastion
    45  }