1. Packages
  2. Amazon EKS
  3. API Docs
  4. Addon
Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi

eks.Addon

Explore with Pulumi AI

eks logo
Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi

    Addon manages an EKS add-on. For more information about supported add-ons, see: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html

    Create Addon Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Addon(name: string, args: AddonArgs, opts?: CustomResourceOptions);
    @overload
    def Addon(resource_name: str,
              args: AddonArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Addon(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              addon_name: Optional[str] = None,
              cluster: Optional[Cluster] = None,
              addon_version: Optional[str] = None,
              configuration_values: Optional[Mapping[str, Any]] = None,
              preserve: Optional[bool] = None,
              resolve_conflicts_on_create: Optional[str] = None,
              resolve_conflicts_on_update: Optional[str] = None,
              service_account_role_arn: Optional[str] = None,
              tags: Optional[Sequence[Mapping[str, str]]] = None)
    func NewAddon(ctx *Context, name string, args AddonArgs, opts ...ResourceOption) (*Addon, error)
    public Addon(string name, AddonArgs args, CustomResourceOptions? opts = null)
    public Addon(String name, AddonArgs args)
    public Addon(String name, AddonArgs args, CustomResourceOptions options)
    
    type: eks:Addon
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AddonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AddonArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AddonArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddonArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var addonResource = new Eks.Addon("addonResource", new()
    {
        AddonName = "string",
        Cluster = cluster,
        AddonVersion = "string",
        ConfigurationValues = 
        {
            { "string", "any" },
        },
        Preserve = false,
        ResolveConflictsOnCreate = "string",
        ResolveConflictsOnUpdate = "string",
        ServiceAccountRoleArn = "string",
        Tags = new[]
        {
            
            {
                { "string", "string" },
            },
        },
    });
    
    example, err := eks.NewAddon(ctx, "addonResource", &eks.AddonArgs{
    AddonName: pulumi.String("string"),
    Cluster: pulumi.Any(cluster),
    AddonVersion: pulumi.String("string"),
    ConfigurationValues: pulumi.Map{
    "string": pulumi.Any("any"),
    },
    Preserve: pulumi.Bool(false),
    ResolveConflictsOnCreate: pulumi.String("string"),
    ResolveConflictsOnUpdate: pulumi.String("string"),
    ServiceAccountRoleArn: pulumi.String("string"),
    Tags: pulumi.StringMapArray{
    pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    },
    })
    
    var addonResource = new Addon("addonResource", AddonArgs.builder()
        .addonName("string")
        .cluster(cluster)
        .addonVersion("string")
        .configurationValues(Map.of("string", "any"))
        .preserve(false)
        .resolveConflictsOnCreate("string")
        .resolveConflictsOnUpdate("string")
        .serviceAccountRoleArn("string")
        .tags(Map.of("string", "string"))
        .build());
    
    addon_resource = eks.Addon("addonResource",
        addon_name="string",
        cluster=cluster,
        addon_version="string",
        configuration_values={
            "string": "any",
        },
        preserve=False,
        resolve_conflicts_on_create="string",
        resolve_conflicts_on_update="string",
        service_account_role_arn="string",
        tags=[{
            "string": "string",
        }])
    
    const addonResource = new eks.Addon("addonResource", {
        addonName: "string",
        cluster: cluster,
        addonVersion: "string",
        configurationValues: {
            string: "any",
        },
        preserve: false,
        resolveConflictsOnCreate: "string",
        resolveConflictsOnUpdate: "string",
        serviceAccountRoleArn: "string",
        tags: [{
            string: "string",
        }],
    });
    
    type: eks:Addon
    properties:
        addonName: string
        addonVersion: string
        cluster: ${cluster}
        configurationValues:
            string: any
        preserve: false
        resolveConflictsOnCreate: string
        resolveConflictsOnUpdate: string
        serviceAccountRoleArn: string
        tags:
            - string: string
    

    Addon Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Addon resource accepts the following input properties:

    AddonName string
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    Cluster Pulumi.Eks.Cluster
    The target EKS cluster.
    AddonVersion string
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    ConfigurationValues Dictionary<string, object>
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    Preserve bool
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    ResolveConflictsOnCreate string
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    ResolveConflictsOnUpdate string
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    ServiceAccountRoleArn string
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    Tags List<ImmutableDictionary<string, string>>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AddonName string
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    Cluster Cluster
    The target EKS cluster.
    AddonVersion string
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    ConfigurationValues map[string]interface{}
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    Preserve bool
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    ResolveConflictsOnCreate string
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    ResolveConflictsOnUpdate string
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    ServiceAccountRoleArn string
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    Tags []map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addonName String
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    cluster Cluster
    The target EKS cluster.
    addonVersion String
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    configurationValues Map<String,Object>
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    preserve Boolean
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    resolveConflictsOnCreate String
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    resolveConflictsOnUpdate String
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    serviceAccountRoleArn String
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    tags List<Map<String,String>>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addonName string
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    cluster Cluster
    The target EKS cluster.
    addonVersion string
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    configurationValues {[key: string]: any}
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    preserve boolean
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    resolveConflictsOnCreate string
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    resolveConflictsOnUpdate string
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    serviceAccountRoleArn string
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    tags {[key: string]: string}[]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addon_name str
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    cluster Cluster
    The target EKS cluster.
    addon_version str
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    configuration_values Mapping[str, Any]
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    preserve bool
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    resolve_conflicts_on_create str
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    resolve_conflicts_on_update str
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    service_account_role_arn str
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    tags Sequence[Mapping[str, str]]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addonName String
    Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
    cluster eks:Cluster
    The target EKS cluster.
    addonVersion String
    The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
    configurationValues Map<Any>
    Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
    preserve Boolean
    Indicates if you want to preserve the created resources when deleting the EKS add-on.
    resolveConflictsOnCreate String
    How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
    resolveConflictsOnUpdate String
    How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
    serviceAccountRoleArn String
    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

                        Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
    tags List<Map<String>>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Addon resource produces the following output properties:

    Package Details

    Repository
    Amazon EKS pulumi/pulumi-eks
    License
    Apache-2.0
    eks logo
    Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi