Delete Express Gateway Service

ecs_delete_express_gateway_service

R Documentation

Deletes an Express service and removes all associated Amazon Web Services resources¶

Description¶

Deletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load Balancer, target groups, security groups, auto-scaling policies, and other managed infrastructure components.

The service enters a DRAINING state where existing tasks complete current requests without starting new tasks. After all tasks stop, the service and infrastructure are permanently removed.

This operation cannot be reversed. Back up important data and verify the service is no longer needed before deletion.

Usage¶

ecs_delete_express_gateway_service(serviceArn)

Arguments¶

serviceArn

[required] The Amazon Resource Name (ARN) of the Express service to delete. The ARN uniquely identifies the service within your Amazon Web Services account and region.

Value¶

A list with the following syntax:

list(
  service = list(
    cluster = "string",
    serviceName = "string",
    serviceArn = "string",
    infrastructureRoleArn = "string",
    status = list(
      statusCode = "ACTIVE"|"DRAINING"|"INACTIVE",
      statusReason = "string"
    ),
    currentDeployment = "string",
    activeConfigurations = list(
      list(
        serviceRevisionArn = "string",
        executionRoleArn = "string",
        taskRoleArn = "string",
        cpu = "string",
        memory = "string",
        networkConfiguration = list(
          securityGroups = list(
            "string"
          ),
          subnets = list(
            "string"
          )
        ),
        healthCheckPath = "string",
        primaryContainer = list(
          image = "string",
          containerPort = 123,
          awsLogsConfiguration = list(
            logGroup = "string",
            logStreamPrefix = "string"
          ),
          repositoryCredentials = list(
            credentialsParameter = "string"
          ),
          command = list(
            "string"
          ),
          environment = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          secrets = list(
            list(
              name = "string",
              valueFrom = "string"
            )
          )
        ),
        scalingTarget = list(
          minTaskCount = 123,
          maxTaskCount = 123,
          autoScalingMetric = "AVERAGE_CPU"|"AVERAGE_MEMORY"|"REQUEST_COUNT_PER_TARGET",
          autoScalingTargetValue = 123
        ),
        ingressPaths = list(
          list(
            accessType = "PUBLIC"|"PRIVATE",
            endpoint = "string"
          )
        ),
        createdAt = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$delete_express_gateway_service(
  serviceArn = "string"
)