Class: Aws::Batch::Types::EksPodProperties

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::EksPodProperties

Defined in:

gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

The properties for the pod.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #containers ⇒ Array<Types::EksContainer>

  The properties of the container that's used on the Amazon EKS pod.

• #dns_policy ⇒ String

  The DNS policy for the pod.

• #host_network ⇒ Boolean

  Indicates if the pod uses the hosts' network IP address.

• #image_pull_secrets ⇒ Array<Types::ImagePullSecret>

  References a Kubernetes secret resource.

• #init_containers ⇒ Array<Types::EksContainer>

  These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.

• #metadata ⇒ Types::EksMetadata

  Metadata about the Kubernetes pod.

• #service_account_name ⇒ String

  The name of the service account that's used to run the pod.

• #share_process_namespace ⇒ Boolean

  Indicates if the processes in a container are shared, or visible, to other containers in the same pod.

• #volumes ⇒ Array<Types::EksVolume>

  Specifies the volumes for a job definition that uses Amazon EKS resources.

Instance Attribute Details

#containers ⇒ Array<Types::EksContainer>

The properties of the container that's used on the Amazon EKS pod.

This object is limited to 10 elements.

Returns:

• (Array<Types::EksContainer>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#dns_policy ⇒ String

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#host_network ⇒ Boolean

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

Returns:

• (Boolean)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#image_pull_secrets ⇒ Array<Types::ImagePullSecret>

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

Returns:

• (Array<Types::ImagePullSecret>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#init_containers ⇒ Array<Types::EksContainer>

These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation.

This object is limited to 10 elements.

Returns:

• (Array<Types::EksContainer>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Types::EksMetadata

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Returns:

• (Types::EksMetadata)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#service_account_name ⇒ String

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#share_process_namespace ⇒ Boolean

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

Returns:

• (Boolean)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#volumes ⇒ Array<Types::EksVolume>

Specifies the volumes for a job definition that uses Amazon EKS resources.

Returns:

• (Array<Types::EksVolume>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4305

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end