Package io.fabric8.openshift.api.model.installer.aws.v1

Class Platform

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Platform
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    Platform stores all the global configuration that all machinesets use.
    See Also:
    Serialized Form

    • Method Detail

      • getAmiID

        public String getAmiID()
        The field is deprecated. AMIID is the AMI that should be used to boot machines for the cluster. If set, the AMI should belong to the same region as the cluster.

      • setAmiID

        public void setAmiID​(String amiID)
        The field is deprecated. AMIID is the AMI that should be used to boot machines for the cluster. If set, the AMI should belong to the same region as the cluster.

      • getBestEffortDeleteIgnition

        public Boolean getBestEffortDeleteIgnition()
        BestEffortDeleteIgnition is an optional field that can be used to ignore errors from S3 deletion of ignition objects during cluster bootstrap. The default behavior is to fail the installation if ignition objects cannot be deleted. Enable this functionality when there are known reasons disallowing their deletion.

      • setBestEffortDeleteIgnition

        public void setBestEffortDeleteIgnition​(Boolean bestEffortDeleteIgnition)
        BestEffortDeleteIgnition is an optional field that can be used to ignore errors from S3 deletion of ignition objects during cluster bootstrap. The default behavior is to fail the installation if ignition objects cannot be deleted. Enable this functionality when there are known reasons disallowing their deletion.

      • getDefaultMachinePlatform

        public MachinePool getDefaultMachinePlatform()
        Platform stores all the global configuration that all machinesets use.

      • setDefaultMachinePlatform

        public void setDefaultMachinePlatform​(MachinePool defaultMachinePlatform)
        Platform stores all the global configuration that all machinesets use.

      • getHostedZone

        public String getHostedZone()
        HostedZone is the ID of an existing hosted zone into which to add DNS records for the cluster's internal API. An existing hosted zone can only be used when also using existing subnets. The hosted zone must be associated with the VPC containing the subnets. Leave the hosted zone unset to have the installer create the hosted zone on your behalf.

      • setHostedZone

        public void setHostedZone​(String hostedZone)
        HostedZone is the ID of an existing hosted zone into which to add DNS records for the cluster's internal API. An existing hosted zone can only be used when also using existing subnets. The hosted zone must be associated with the VPC containing the subnets. Leave the hosted zone unset to have the installer create the hosted zone on your behalf.

      • getHostedZoneRole

        public String getHostedZoneRole()
        HostedZoneRole is the ARN of an IAM role to be assumed when performing operations on the provided HostedZone. HostedZoneRole can be used in a shared VPC scenario when the private hosted zone belongs to a different account than the rest of the cluster resources. If HostedZoneRole is set, HostedZone must also be set.

      • setHostedZoneRole

        public void setHostedZoneRole​(String hostedZoneRole)
        HostedZoneRole is the ARN of an IAM role to be assumed when performing operations on the provided HostedZone. HostedZoneRole can be used in a shared VPC scenario when the private hosted zone belongs to a different account than the rest of the cluster resources. If HostedZoneRole is set, HostedZone must also be set.

      • getLbType

        public String getLbType()
        LBType is an optional field to specify a load balancer type. When this field is specified, all ingresscontrollers (including the default ingresscontroller) will be created using the specified load-balancer type by default.


        Following are the accepted values:


        * "Classic": A Classic Load Balancer that makes routing decisions at either the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb


        * "NLB": A Network Load Balancer that makes routing decisions at the transport layer (TCP/SSL). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb


        If this field is not set explicitly, it defaults to "Classic". This default is subject to change over time.

      • setLbType

        public void setLbType​(String lbType)
        LBType is an optional field to specify a load balancer type. When this field is specified, all ingresscontrollers (including the default ingresscontroller) will be created using the specified load-balancer type by default.


        Following are the accepted values:


        * "Classic": A Classic Load Balancer that makes routing decisions at either the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb


        * "NLB": A Network Load Balancer that makes routing decisions at the transport layer (TCP/SSL). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb


        If this field is not set explicitly, it defaults to "Classic". This default is subject to change over time.

      • getPreserveBootstrapIgnition

        public Boolean getPreserveBootstrapIgnition()
        PreserveBootstrapIgnition is deprecated. Use bestEffortDeleteIgnition instead.

      • setPreserveBootstrapIgnition

        public void setPreserveBootstrapIgnition​(Boolean preserveBootstrapIgnition)
        PreserveBootstrapIgnition is deprecated. Use bestEffortDeleteIgnition instead.

      • getPropagateUserTags

        public Boolean getPropagateUserTags()
        PropagateUserTags is a flag that directs in-cluster operators to include the specified user tags in the tags of the AWS resources that the operators create.

      • setPropagateUserTags

        public void setPropagateUserTags​(Boolean propagateUserTags)
        PropagateUserTags is a flag that directs in-cluster operators to include the specified user tags in the tags of the AWS resources that the operators create.

      • getPublicIpv4Pool

        public String getPublicIpv4Pool()
        PublicIpv4Pool is an optional field that can be used to tell the installation process to use Public IPv4 address that you bring to your AWS account with BYOIP.

      • setPublicIpv4Pool

        public void setPublicIpv4Pool​(String publicIpv4Pool)
        PublicIpv4Pool is an optional field that can be used to tell the installation process to use Public IPv4 address that you bring to your AWS account with BYOIP.

      • getRegion

        public String getRegion()
        Region specifies the AWS region where the cluster will be created.

      • setRegion

        public void setRegion​(String region)
        Region specifies the AWS region where the cluster will be created.

      • getServiceEndpoints

        public List<ServiceEndpoint> getServiceEndpoints()
        ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.

      • setServiceEndpoints

        public void setServiceEndpoints​(List<ServiceEndpoint> serviceEndpoints)
        ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.

      • getSubnets

        public List<String> getSubnets()
        Subnets specifies existing subnets (by ID) where cluster resources will be created. Leave unset to have the installer create subnets in a new VPC on your behalf.


        Deprecated: use platform.aws.vpc.subnets

      • setSubnets

        public void setSubnets​(List<String> subnets)
        Subnets specifies existing subnets (by ID) where cluster resources will be created. Leave unset to have the installer create subnets in a new VPC on your behalf.


        Deprecated: use platform.aws.vpc.subnets

      • getUserProvisionedDNS

        public String getUserProvisionedDNS()
        UserProvisionedDNS indicates if the customer is providing their own DNS solution in place of the default provisioned by the Installer.

      • setUserProvisionedDNS

        public void setUserProvisionedDNS​(String userProvisionedDNS)
        UserProvisionedDNS indicates if the customer is providing their own DNS solution in place of the default provisioned by the Installer.

      • getUserTags

        public Map<String,​String> getUserTags()
        UserTags additional keys and values that the installer will add as tags to all resources that it creates. Resources created by the cluster itself may not include these tags.

      • setUserTags

        public void setUserTags​(Map<String,​String> userTags)
        UserTags additional keys and values that the installer will add as tags to all resources that it creates. Resources created by the cluster itself may not include these tags.

      • getVpc

        public VPC getVpc()
        Platform stores all the global configuration that all machinesets use.

      • setVpc

        public void setVpc​(VPC vpc)
        Platform stores all the global configuration that all machinesets use.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)