Class: Aws::Batch::Types::EksPodPropertiesDetail

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::EksPodPropertiesDetail

Defined in:

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

Overview

The details for the pod.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #containers ⇒ Array<Types::EksContainerDetail>

  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>

  Displays the reference pointer to the Kubernetes secret resource.

• #init_containers ⇒ Array<Types::EksContainerDetail>

  The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

• #metadata ⇒ Types::EksMetadata

  Describes and uniquely identifies Kubernetes resources.

• #node_name ⇒ String

  The name of the node for this job.

• #pod_name ⇒ String

  The name of the pod for this job.

• #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 using Amazon EKS resources.

Instance Attribute Details

#containers ⇒ Array<Types::EksContainerDetail>

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

Returns:

• (Array<Types::EksContainerDetail>)

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

class EksPodPropertiesDetail < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :pod_name,
  :node_name,
  :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. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. 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 4304

class EksPodPropertiesDetail < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :pod_name,
  :node_name,
  :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 4304

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

#image_pull_secrets ⇒ Array<Types::ImagePullSecret>

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

Returns:

• (Array<Types::ImagePullSecret>)

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

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

#init_containers ⇒ Array<Types::EksContainerDetail>

The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

Returns:

• (Array<Types::EksContainerDetail>)

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

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

#metadata ⇒ Types::EksMetadata

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the 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 4304

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

#node_name ⇒ String

The name of the node for this job.

Returns:

• (String)

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

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

#pod_name ⇒ String

The name of the pod for this job.

Returns:

• (String)

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

class EksPodPropertiesDetail < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :pod_name,
  :node_name,
  :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 4304

class EksPodPropertiesDetail < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :pod_name,
  :node_name,
  :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 4304

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

#volumes ⇒ Array<Types::EksVolume>

Specifies the volumes for a job definition using Amazon EKS resources.

Returns:

• (Array<Types::EksVolume>)

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

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